Skip to content

Commit 94c663c

Browse files
update readme (#4)
* add a usage note * update note * typo * add github release version badge
1 parent 453cb70 commit 94c663c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[![GoDoc](https://godoc.org/github.com/augmentable-dev/tickgit?status.svg)](https://godoc.org/github.com/augmentable-dev/tickgit)
22
[![BuildStatus](https://github.com/augmentable-dev/tickgit/workflows/tests/badge.svg)](https://github.com/augmentable-dev/tickgit/actions?workflow=tests)
33
[![Go Report Card](https://goreportcard.com/badge/github.com/augmentable-dev/tickgit)](https://goreportcard.com/report/github.com/augmentable-dev/tickgit)
4+
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/augmentable-dev/tickgit)
45

56
## tickgit 🎟️
67

@@ -54,3 +55,8 @@ To be honest, I'm not sure yet. This project is a POC I'm exploring. Keeping tic
5455
brew tap augmentable-dev/tickgit
5556
brew install tickgit
5657
```
58+
59+
60+
### Usage
61+
62+
The most up to date usage will be the output of `tickgit --help`. The most common usage, however, is `tickgit status` which will print a status report of tickets for a given git repository. By default, it uses the current working directory.

0 commit comments

Comments
 (0)