From 4545ff3aa17882cf7f3b682eb09086a88abbe60a Mon Sep 17 00:00:00 2001 From: "lynn [they]" Date: Wed, 13 Nov 2019 14:03:36 -0800 Subject: [PATCH 1/2] Mention `v2` first --- README.md | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 363bb5d..c14cf5e 100644 --- a/README.md +++ b/README.md @@ -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. -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 @@ -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). From 7739b8cf8863377aa5efd9c99a82a5e91ac8a743 Mon Sep 17 00:00:00 2001 From: "lynn [they]" Date: Thu, 14 Nov 2019 12:51:31 -0800 Subject: [PATCH 2/2] Update README.md Co-Authored-By: Sascha Grunert --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c14cf5e..ffb9e2e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ $ go get github.com/urfave/cli.v2 ```go ... import ( - "github.com/urfave/cli.v2" // imports as package "cli" + "github.com/urfave/cli/v2" // imports as package "cli" ) ... ```