From 1beb5f66cd28d7d39c93bace3a5550ab8e454dc3 Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Mon, 16 May 2016 10:43:05 -0400 Subject: [PATCH 1/3] Add some docs about the `v2` branch --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index bffd052..0f9aa33 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,27 @@ Make sure your `PATH` includes to the `$GOPATH/bin` directory so your commands c 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 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()`. From 8af550936f59d101e8173a23cd41f8202f6bd67a Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Mon, 16 May 2016 10:46:43 -0400 Subject: [PATCH 2/3] Add another bit about pinning to `v1` --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0f9aa33..ac59994 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,24 @@ import ( ... ``` +### Pinning to the `v1` branch + +Similarly to the section above describing use of the `v2` branch, if one wants +to avoid any unexpected compatibility pains once `v2` becomes `master`, then +pinning to the `v1` branch is an acceptable option, e.g.: + +``` +$ go get gopkg.in/codegangsta/cli.v1 +``` + +``` go +... +import ( + "gopkg.in/codegangsta/cli.v1" // imports as package "cli" +) +... +``` + ## 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()`. From 61e5e9362f9657038caf04eea2e2c2f84901a7c0 Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Mon, 16 May 2016 10:48:21 -0400 Subject: [PATCH 3/3] Clarify state of `v1` branch --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ac59994..e5b01bd 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,11 @@ export PATH=$PATH:$GOPATH/bin 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`: +`master` branch (current mirrored as `v1`) is being manually merged into `v2` on +an irregular human-based 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