From f2c26bab772e6b69a9fca945534728678578eb2b Mon Sep 17 00:00:00 2001 From: russoj88 Date: Tue, 13 Aug 2019 21:10:38 -0700 Subject: [PATCH 1/5] Rewrite the "pinning to v1" section. --- README.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 29ed171..6748476 100644 --- a/README.md +++ b/README.md @@ -108,25 +108,12 @@ import ( ... ``` -### Pinning to the `v1` releases +### Using `v1` releases -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 `v1` is an acceptable option, e.g.: +Use the github URL to use the v1 branch. This is illustrated in the Getting Started section below. -``` -$ go get gopkg.in/urfave/cli.v1 -``` - -``` go -... -import ( - "gopkg.in/urfave/cli.v1" // imports as package "cli" -) -... -``` +Do not use the gopkg.in URL as it does not work for versions >= 1.21.0. -This will pull the latest tagged `v1` release (e.g. `v1.18.1` at the time of writing). ## Getting Started From f529dad70caa6e307f95eecb2db6f16efc0f964d Mon Sep 17 00:00:00 2001 From: russoj88 Date: Wed, 14 Aug 2019 11:20:58 -0700 Subject: [PATCH 2/5] Update README.md Include suggestion to put example in. Co-Authored-By: Lynn Cyrin (they/them) --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6748476..9ecef10 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,13 @@ import ( ### Using `v1` releases -Use the github URL to use the v1 branch. This is illustrated in the Getting Started section below. +$ go get github.com/urfave/cli + +package main + +import ( + "github.com/urfave/cli" +) Do not use the gopkg.in URL as it does not work for versions >= 1.21.0. From cc091db561b137c49cbf370766a94b47cfdae182 Mon Sep 17 00:00:00 2001 From: russoj88 Date: Wed, 14 Aug 2019 11:21:40 -0700 Subject: [PATCH 3/5] Update README.md Only instruct on right way to use library. Co-Authored-By: Lynn Cyrin (they/them) --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 9ecef10..f611bfa 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,6 @@ import ( "github.com/urfave/cli" ) -Do not use the gopkg.in URL as it does not work for versions >= 1.21.0. ## Getting Started From 62b8a7cc2cb05b1a454908087b35e5780a1d12ad Mon Sep 17 00:00:00 2001 From: russoj88 Date: Wed, 14 Aug 2019 11:20:09 -0700 Subject: [PATCH 4/5] Add "Using v1 releases" to table of contents. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f611bfa..224224c 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ applications in an expressive way. - [Installation](#installation) * [Supported platforms](#supported-platforms) * [Using the `v2` branch](#using-the-v2-branch) - * [Pinning to the `v1` releases](#pinning-to-the-v1-releases) + * [Using `v1` releases](#using-v1-releases) - [Getting Started](#getting-started) - [Examples](#examples) * [Arguments](#arguments) From 3bc62c4fde03e107cad02f8828780470258b8fc0 Mon Sep 17 00:00:00 2001 From: russoj88 Date: Thu, 15 Aug 2019 12:30:29 -0700 Subject: [PATCH 5/5] Mimic v2 example code from above. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 224224c..cbb0b37 100644 --- a/README.md +++ b/README.md @@ -110,14 +110,17 @@ import ( ### Using `v1` releases +``` $ go get github.com/urfave/cli +``` -package main - +```go +... import ( "github.com/urfave/cli" ) - +... +``` ## Getting Started