Merge pull request #927 from urfave/lynncyrin-patch-2

Mention `v2` first
main
lynn [they] 5 years ago committed by GitHub
commit c443515517
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -15,29 +15,26 @@ applications in an expressive way.
## Usage Documentation ## Usage Documentation
Usage documentation exists for each major version Usage documentation exists for each major version. Don't know what version you're on? You're probably using the version from the `master` branch, which is currently `v2`.
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
- `v2` - [./docs/v2/manual.md](./docs/v2/manual.md) - `v2` - [./docs/v2/manual.md](./docs/v2/manual.md)
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
## Installation ### Using `v2` releases
Make sure you have a working Go environment. Go version 1.10+ is supported. [See
the install instructions for Go](http://golang.org/doc/install.html).
### GOPATH **Warning**: `v2` is in a beta state.
Make sure your `PATH` includes the `$GOPATH/bin` directory so your commands can
be easily used:
``` ```
export PATH=$PATH:$GOPATH/bin $ go get github.com/urfave/cli.v2
``` ```
### Supported platforms ```go
...
cli is tested against multiple versions of Go on Linux, and against the latest import (
released version of Go on OS X and Windows. For full details, see "github.com/urfave/cli/v2" // imports as package "cli"
[`./.travis.yml`](./.travis.yml) and [`./appveyor.yml`](./appveyor.yml). )
...
```
### Using `v1` releases ### Using `v1` releases
@ -53,18 +50,21 @@ import (
... ...
``` ```
### Using `v2` releases ## Installation
**Warning**: `v2` is in a beta state. Make sure you have a working Go environment. Go version 1.10+ is supported. [See
the install instructions for Go](http://golang.org/doc/install.html).
### GOPATH
Make sure your `PATH` includes the `$GOPATH/bin` directory so your commands can
be easily used:
``` ```
$ go get github.com/urfave/cli.v2 export PATH=$PATH:$GOPATH/bin
``` ```
```go ### Supported platforms
...
import ( cli is tested against multiple versions of Go on Linux, and against the latest
"github.com/urfave/cli.v2" // imports as package "cli" released version of Go on OS X and Windows. For full details, see
) [`./.travis.yml`](./.travis.yml) and [`./appveyor.yml`](./appveyor.yml).
...
```

Loading…
Cancel
Save