diff --git a/.gitignore b/.gitignore index 98d4117fa4abaee01afc6d4ddcef857cd333727f..42d66f9b16ea46f02a2f0ab137ec2c63c53e4996 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ git-bug -!/doc/bash_completion/git-bug -!/doc/zsh_completion/git-bug +!/misc/bash_completion/git-bug +!/misc/zsh_completion/git-bug .gitkeep dist coverage.txt diff --git a/Readme.md b/Readme.md index 6142f30871205d17d397b6bf53d63460eb65dbf0..3de5aa0404c11f55a9f1f453a417d22bc67a4a43 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,9 @@ # git-bug +[![Build Status](https://travis-ci.org/MichaelMure/git-bug.svg?branch=master)](https://travis-ci.org/MichaelMure/git-bug) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3+-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) +[![GoDoc](https://godoc.org/github.com/MichaelMure/git-bug?status.svg)](https://godoc.org/github.com/MichaelMure/git-bug) + > Bugtracker embedded in Git Would it be nice to not have to rely on a web service somewhere to deal with bugs ? @@ -24,15 +28,15 @@ export PATH=$PATH:$GOROOT/bin:$GOPATH/bin That's all ! In the future, pre-compiled binary will be provided for convenience. -## Usage +## CLI usage -It's really a WIP but you can already create a bug: +Create a new bug: ``` -git bug new "This doesn't even build" +git bug new ``` -Your favorite editor will open to write a description. +Your favorite editor will open to write a title and a message. You can push your new entry to a remote: ``` @@ -44,56 +48,50 @@ And pull for updates: git bug pull [] ``` -You can now use commands like `show`, `comment`, `open` or `close` to display and modify bugs. - -## All commands +List existing bugs: +``` +git bug ls +``` -```bash -# Mark the bug as closed -git bug close +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). -# Display available commands -git bug commands [