From dd591ee018bf52302c3f7d6ee7644b27a77f0739 Mon Sep 17 00:00:00 2001 From: Patrick DeVivo Date: Sun, 14 Jun 2020 21:41:11 -0400 Subject: [PATCH 1/3] add some additional installation instructions --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c63aee..9055881 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,22 @@ brew tap augmentable-dev/tickgit brew install tickgit ``` +#### GoBinaries + +``` +curl -sf https://gobinaries.com/github.com/augmentable-dev/tickgit/cmd/tickgit | sh +``` + +Will use [GoBinaries](https://gobinaries.com/) to install the latest version of `tickgit` (or a specified one). + +#### 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`. From d51e57203eb4a10ec82b124bc369d98056d85e1e Mon Sep 17 00:00:00 2001 From: Patrick DeVivo Date: Sun, 14 Jun 2020 21:43:17 -0400 Subject: [PATCH 2/3] version clarification, rm optional github.com --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9055881..602733d 100644 --- a/README.md +++ b/README.md @@ -60,10 +60,11 @@ brew install tickgit #### GoBinaries ``` -curl -sf https://gobinaries.com/github.com/augmentable-dev/tickgit/cmd/tickgit | sh +curl -sf https://gobinaries.com/augmentable-dev/tickgit/cmd/tickgit | sh ``` -Will use [GoBinaries](https://gobinaries.com/) to install the latest version of `tickgit` (or a specified one). +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 From 8365a28aefa3911fbb41dcbd378911daf54ff834 Mon Sep 17 00:00:00 2001 From: Patrick DeVivo Date: Sun, 14 Jun 2020 21:44:52 -0400 Subject: [PATCH 3/3] add some backticks --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 602733d..1e828c6 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ You can specifiy a particular version by appending `@VERSION` to the URL above. go install github.com/augmentable-dev/tickgit/cmd/tickgit ``` -With $GOBIN set and in your $PATH. +With `$GOBIN` set and in your `$PATH`. ### Usage