diff --git a/README.md b/README.md index 9c63aee..1e828c6 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,8 @@ Check out [an example](https://www.tickgit.com/browse?repo=github.com/kubernetes #### Coming Soon - [x] Blame - get a better sense of how old TODOs are, when they were introduced and by whom +- [x] More `TODO` type phrases to match, such as `FIXME`, `XXX`, `HACK`, or customized alternatives. - [ ] Context - more visibility into the lines of code _around_ a TODO for greater context -- [ ] More `TODO` type phrases to match, such as `FIXME`, `XXX`, `HACK`, or customized alternatives. - [ ] More configurability (e.g. custom ignore paths) - [ ] Markdown parsing - [ ] More thorough historical stats @@ -57,6 +57,23 @@ brew tap augmentable-dev/tickgit brew install tickgit ``` +#### GoBinaries + +``` +curl -sf https://gobinaries.com/augmentable-dev/tickgit/cmd/tickgit | sh +``` + +Will use [GoBinaries](https://gobinaries.com/) to install the latest version of `tickgit`. +You can specifiy a particular version by appending `@VERSION` to the URL above. + +#### go install + +``` +go install github.com/augmentable-dev/tickgit/cmd/tickgit +``` + +With `$GOBIN` set and in your `$PATH`. + ### Usage The most up to date usage will be the output of `tickgit --help`.