Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention v2 first #927

Merged
merged 2 commits into from
Nov 15, 2019
Merged

Mention v2 first #927

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4545ff3
Mention `v2` first
Nov 13, 2019
7739b8c
Update README.md
Nov 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,26 @@ applications in an expressive way.

## 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)
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)

## Installation

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).
### Using `v2` releases

### GOPATH
**Warning**: `v2` is in a beta state.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it's not really a beta, but rather early days, as beta implies that people should use v1 for something stable, which I don't think is what we want.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll think on the wording here for a bit, and stand up a PR for changing this line 👍


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

cli is tested against multiple versions of Go on Linux, and against the latest
released version of Go on OS X and Windows. For full details, see
[`./.travis.yml`](./.travis.yml) and [`./appveyor.yml`](./appveyor.yml).
```go
...
import (
"github.com/urfave/cli/v2" // imports as package "cli"
)
...
```

### Using `v1` releases

Expand All @@ -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
...
import (
"github.com/urfave/cli.v2" // imports as package "cli"
)
...
```
### Supported platforms

cli is tested against multiple versions of Go on Linux, and against the latest
released version of Go on OS X and Windows. For full details, see
[`./.travis.yml`](./.travis.yml) and [`./appveyor.yml`](./appveyor.yml).