aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAmine Hilaly <hilalyamine@gmail.com>2019-08-24 13:55:49 +0200
committerAmine Hilaly <hilalyamine@gmail.com>2019-08-24 13:55:49 +0200
commit03b6afa2f3a73bdecf29ba9c19ef1877bfd596a5 (patch)
treefd3e2ab7977ff3dcc6df3491c9fdb47e7afeea86
parent2585726ac39c95b5ad81bc5bece003b79c0b5faa (diff)
downloadgit-bug-03b6afa2f3a73bdecf29ba9c19ef1877bfd596a5.tar.gz
docs: update implementation table
docs: add bridge usage examples
-rw-r--r--README.md40
-rw-r--r--commands/bridge_configure.go11
2 files changed, 42 insertions, 9 deletions
diff --git a/README.md b/README.md
index 459fabc8..ca2b93e5 100644
--- a/README.md
+++ b/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
diff --git a/commands/bridge_configure.go b/commands/bridge_configure.go
index e3576ead..74ccf298 100644
--- a/commands/bridge_configure.go
+++ b/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,
}