From 35c6cb6e36a0db48bfed2cd7ba5954537f9dfae6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Mur=C3=A9?= Date: Sat, 24 Aug 2019 14:18:22 +0200 Subject: [PATCH] readme: tweaking --- README.md | 24 +++++++++++++++++------- commands/bridge_configure.go | 2 +- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ca2b93e5ab1447fdc3d6b04a26ef7b29bb26bd63..0c1f4fcbd2ced443f178d29c0f30976775a3d5c1 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,14 @@ The web UI interact with the backend through a GraphQL API. The schema is availa #### Bridge usage -configure a new github bridge +Interactively configure a new github bridge: + +```bash +git bug bridge configure +``` + +Or manually: + ```bash git bug bridge configure \ --name=mybridge \ @@ -154,19 +161,22 @@ git bug bridge configure \ --token=$TOKEN ``` -import bugs +Import bugs: + ```bash -git bug bridge pull mybridge +git bug bridge pull [] ``` -export modifications +Export modifications: + ```bash -git bug bridge push mybridge +git bug bridge push [] ``` -deleting a bridge +Deleting a bridge: + ```bash -git bug bridge rm mybridge +git bug bridge rm [] ``` ## Internals diff --git a/commands/bridge_configure.go b/commands/bridge_configure.go index 74ccf29896ab4568df1c75814319d1a15fc150ad..6bebc26245de7647fa997f07ef20414f1c490472 100644 --- a/commands/bridge_configure.go +++ b/commands/bridge_configure.go @@ -176,7 +176,7 @@ git bug bridge configure \ # For Gitlab git bug bridge configure \ - --name=mybridge \ + --name=default \ --target=github \ --url=https://github.com/michaelmure/git-bug \ --token=$(TOKEN)`,