aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-08-08 18:51:11 +0200
committerMichael Muré <batolettre@gmail.com>2018-08-08 18:51:11 +0200
commitca4c829ed0416f146d890fc11b2c3c07104c13d2 (patch)
treeaab045ecb3e69ac5956c22b68c44135fe744f9e0 /README.md
parent28670ff8de4e8a266a191265d1b0c57d438e191e (diff)
downloadgit-bug-ca4c829ed0416f146d890fc11b2c3c07104c13d2.tar.gz
readme: cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/README.md b/README.md
index d1de7b8c..0e347b5b 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 <command> --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