From d4334496d3adbb0582253ca09a8ecd9f0b0461b9 Mon Sep 17 00:00:00 2001 From: gkze Date: Sat, 5 Jan 2019 16:08:13 -0800 Subject: [PATCH] Update README --- README.md | 22 ++++++++++++++++------ main.go | 2 +- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index eb63a0a..787900f 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,30 @@ A command-line interface to your GitHub stars ## Development ```bash -git clone git@github.com:gkze/stars-go.git -cd stars-go +git clone git@github.com:gkze/stars.git +cd stars go build # need Golang 1.11+ ``` ## Installation -Binaries are available on the releases page. You can also install it easily with: +### Homebrew + +```bash +brew install gkze/gkze/stars +``` + +### Go ```bash go get -u github.com/gkze/stars ``` -You also need a `~/.netrc` with a personal access token configured: +Binaries are available on the releases page. + +## Configuration + +You will need a `~/.netrc` with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) configured: ```bash $ cat ~/.netrc @@ -27,7 +37,7 @@ machine api.github.com password [your github token here] ``` -Usage: +## Usage ```bash NAME: @@ -37,7 +47,7 @@ USAGE: stars [global options] command [command options] [arguments...] VERSION: - 0.3.9 + 0.4.3 COMMANDS: save Save all stars diff --git a/main.go b/main.go index 078d19d..73abc3f 100644 --- a/main.go +++ b/main.go @@ -21,7 +21,7 @@ func main() { cmdline := cli.NewApp() cmdline.Name = "stars" cmdline.Usage = "Command-line interface to YOUR GitHub stars" - cmdline.Version = "0.3.9" + cmdline.Version = "0.4.3" cmdline.Commands = []cli.Command{ { Name: "save",