Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gkze committed Jan 6, 2019
1 parent 0b59977 commit d433449
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,30 @@ A command-line interface to your GitHub stars
## Development

```bash
git clone [email protected]:gkze/stars-go.git
cd stars-go
git clone [email protected]: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
Expand All @@ -27,7 +37,7 @@ machine api.github.com
password [your github token here]
```

Usage:
## Usage

```bash
NAME:
Expand All @@ -37,7 +47,7 @@ USAGE:
stars [global options] command [command options] [arguments...]

VERSION:
0.3.9
0.4.3

COMMANDS:
save Save all stars
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit d433449

Please sign in to comment.