From ca4c829ed0416f146d890fc11b2c3c07104c13d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Mur=C3=A9?= Date: Wed, 8 Aug 2018 18:51:11 +0200 Subject: [PATCH] readme: cleanup --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d1de7b8c8a8b82a19623f91b571e80a4c2ba6617..0e347b5b2d3e251ed73fccf3a487b8f96de701c1 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ export PATH=$PATH:$GOROOT/bin:$GOPATH/bin That's all ! In the future, pre-compiled binary will be provided for convenience. -## CLI usage +## CLI usage (status: working but need UX improvement) Create a new bug: @@ -57,17 +57,17 @@ git bug ls You can now use commands like `show`, `comment`, `open` or `close` to display and modify bugs. For more details about each command, you can run `git bug --help` or read the [command's documentation](doc/md/git-bug.md). -## Interactive terminal UI +## Interactive terminal UI (status: WIP) -An interactive (WIP) terminal UI is available using the command `git bug termui` to browse and edit bugs. +An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs. ![terminal UI](doc/termui.png) // TODO: replace with less test data ;-) -## Web UI +## Web UI (status: terribly WIP) -You can launch a rich Web UI (terribly WIP) with `git bug webui`. +You can launch a rich Web UI with `git bug webui`. ![Web UI](doc/webui.png) @@ -87,11 +87,10 @@ Interested by how it works ? Have a look at the [data model](doc/model.md). ## Planned features -- [ ] interactive CLI UI -- [ ] rich web UI -- [ ] media embedding -- [ ] import/export of github issue -- [ ] inflatable raptor +- media embedding +- import/export of github issue +- extendable data model to support arbitrary bug tracker +- inflatable raptor ## Contribute