From 03b6afa2f3a73bdecf29ba9c19ef1877bfd596a5 Mon Sep 17 00:00:00 2001 From: Amine Hilaly Date: Sat, 24 Aug 2019 13:55:49 +0200 Subject: docs: update implementation table docs: add bridge usage examples --- README.md | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) (limited to 'README.md') 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 -- cgit From 35c6cb6e36a0db48bfed2cd7ba5954537f9dfae6 Mon Sep 17 00:00:00 2001 From: Michael Muré Date: Sat, 24 Aug 2019 14:18:22 +0200 Subject: readme: tweaking --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) (limited to 'README.md') 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 [] ``` -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 -- cgit