aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-07-16 15:22:09 +0200
committerMichael Muré <batolettre@gmail.com>2018-07-16 15:22:09 +0200
commit6f4661a9e37266c6a2638b5bda220efe89d0f583 (patch)
tree02f1ea3c88b9d413e0f38e91e9310cff58d02c04
parentd3893a5e04868fb99df28c8da62a0ee59d7e9064 (diff)
downloadgit-bug-6f4661a9e37266c6a2638b5bda220efe89d0f583.tar.gz
show available commands in the readme
-rw-r--r--Readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
index fe309ee7..6d1b5fd8 100644
--- a/Readme.md
+++ b/Readme.md
@@ -44,6 +44,28 @@ And pull for updates:
git bug pull [<remote>]
```
+## All commands
+
+```bash
+# Display available commands
+git bug commands [<option>...]
+
+# Add a new comment to a bug
+git bug comment [<options>...] <id>
+
+# Display a summary of all bugs
+git bug ls
+
+# Create a new bug
+git bug new [<option>...] <title>
+
+# Pull bugs update from a git remote
+git bug pull [<remote>]
+
+# Push bugs update to a git remote
+git bug push [<remote>]
+```
+
## Internals
Interested by how it works ? Have a look at the [data model](doc/model.md).