Merge pull request #862 from russoj88/UpdateREADME_gopkg.in_v1

Rewrite the "pinning to v1" section.
main
Lynn Cyrin (they/them) 5 years ago committed by GitHub
commit 23c8303026
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -19,7 +19,7 @@ applications in an expressive way.
- [Installation](#installation) - [Installation](#installation)
* [Supported platforms](#supported-platforms) * [Supported platforms](#supported-platforms)
* [Using the `v2` branch](#using-the-v2-branch) * [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) - [Getting Started](#getting-started)
- [Examples](#examples) - [Examples](#examples)
* [Arguments](#arguments) * [Arguments](#arguments)
@ -104,25 +104,20 @@ 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.:
``` ```
$ go get gopkg.in/urfave/cli.v1 $ go get github.com/urfave/cli
``` ```
``` go ```go
... ...
import ( import (
"gopkg.in/urfave/cli.v1" // imports as package "cli" "github.com/urfave/cli"
) )
... ...
``` ```
This will pull the latest tagged `v1` release (e.g. `v1.18.1` at the time of writing).
## Getting Started ## Getting Started

Loading…
Cancel
Save