x/urfave-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add some docs about the v2 branch

Browse Source
This commit is contained in:
Dan Buch 2016-05-16 10:43:05 -04:00
parent 7f0ca9a349
commit 1beb5f66cd
No known key found for this signature in database
GPG Key ID: FAEF12936DD3E3EC
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -30,6 +30,27 @@ Make sure your `PATH` includes to the `$GOPATH/bin` directory so your commands c
export PATH=$PATH:$GOPATH/bin export PATH=$PATH:$GOPATH/bin
``` ```
### Using the `v2` branch
There is currently a long-lived branch named `v2` that is intended to land as
the new `master` branch once development there has settled down. The current
`master` branch (what will become `v1`) is being manually merged into `v2` on an
irregular human schedule, but generally if one wants to "upgrade" to `v2` *now*
and accept the volatility (read: "awesomeness") that comes along with that,
please use whatever version pinning of your preference, such as via `gopkg.in`:
```
$ go get gopkg.in/codegangsta/cli.v2
```
``` go
...
import (
"gopkg.in/codegangsta/cli.v2" // imports as package "cli"
)
...
```
## Getting Started ## Getting Started
One of the philosophies behind cli is that an API should be playful and full of discovery. So a cli app can be as little as one line of code in `main()`. One of the philosophies behind cli is that an API should be playful and full of discovery. So a cli app can be as little as one line of code in `main()`.