aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2019-08-24 14:18:22 +0200
committerMichael Muré <batolettre@gmail.com>2019-08-24 14:18:22 +0200
commit35c6cb6e36a0db48bfed2cd7ba5954537f9dfae6 (patch)
treec0ca994574c5a71ef355c39d67bcf8dcf74b1407
parent03b6afa2f3a73bdecf29ba9c19ef1877bfd596a5 (diff)
downloadgit-bug-35c6cb6e36a0db48bfed2cd7ba5954537f9dfae6.tar.gz
readme: tweaking
-rw-r--r--README.md24
-rw-r--r--commands/bridge_configure.go2
2 files changed, 18 insertions, 8 deletions
diff --git a/README.md b/README.md
index ca2b93e5..0c1f4fcb 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 [<name>]
```
-export modifications
+Export modifications:
+
```bash
-git bug bridge push mybridge
+git bug bridge push [<name>]
```
-deleting a bridge
+Deleting a bridge:
+
```bash
-git bug bridge rm mybridge
+git bug bridge rm [<name>]
```
## Internals
diff --git a/commands/bridge_configure.go b/commands/bridge_configure.go
index 74ccf298..6bebc262 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)`,