docs: update implementation table

Amine Hilaly created 6 years ago

docs: add bridge usage examples

Change summary

README.md                    | 40 +++++++++++++++++++++++++++++++------
commands/bridge_configure.go | 11 ++++++++-
2 files changed, 42 insertions(+), 9 deletions(-)

Detailed changes

README.md

@@ -135,13 +135,39 @@ The web UI interact with the backend through a GraphQL API. The schema is availa
 
 | | Github | Gitlab | Launchpad |
 | --- | --- | --- | --- |
-| **bug** | :heavy_check_mark: | :x: | :x: |
-| comments | :heavy_check_mark: | :x: | :x: |
-| comment editions | :heavy_check_mark: | :x: | :x: |
-| labels | :heavy_check_mark: | :x: | :x: |
-| status | :heavy_check_mark: | :x: | :x: |
-| title edition | :heavy_check_mark: | :x: | :x: |
-| **automated test suite** | :heavy_check_mark: | :x: | :x: |
+| **bug** | :heavy_check_mark: | :heavy_check_mark: | :x: |
+| comments | :heavy_check_mark: | :heavy_check_mark: | :x: |
+| comment editions | :heavy_check_mark: | :heavy_check_mark: | :x: |
+| labels | :heavy_check_mark: | :heavy_check_mark: | :x: |
+| status | :heavy_check_mark: | :heavy_check_mark: | :x: |
+| title edition | :heavy_check_mark: | :heavy_check_mark: | :x: |
+| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x: |
+
+#### Bridge usage
+
+configure a new github bridge
+```bash
+git bug bridge configure \
+    --name=mybridge \
+    --target=github \
+    --url=https://github.com/michaelmure/git-bug \
+    --token=$TOKEN
+```
+
+import bugs
+```bash
+git bug bridge pull mybridge
+```
+
+export modifications
+```bash
+git bug bridge push mybridge
+```
+
+deleting a bridge
+```bash
+git bug bridge rm mybridge
+```
 
 ## Internals
 

commands/bridge_configure.go

@@ -160,7 +160,7 @@ Private:
 Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700
 Successfully configured bridge: default
 
-# For Github
+# For GitHub
 git bug bridge configure \
     --name=default \
     --target=github \
@@ -172,7 +172,14 @@ git bug bridge configure \
 git bug bridge configure \
     --name=default \
     --target=launchpad-preview \
-    --url=https://bugs.launchpad.net/ubuntu/`,
+	--url=https://bugs.launchpad.net/ubuntu/
+
+# For Gitlab
+git bug bridge configure \
+    --name=mybridge \
+    --target=github \
+    --url=https://github.com/michaelmure/git-bug \
+    --token=$(TOKEN)`,
 	PreRunE: loadRepo,
 	RunE:    runBridgeConfigure,
 }