Skip to content

Commit

Permalink
Merge pull request #862 from russoj88/UpdateREADME_gopkg.in_v1
Browse files Browse the repository at this point in the history
Rewrite the "pinning to v1" section.
  • Loading branch information
Lynn Cyrin (they/them) committed Aug 17, 2019
2 parents ecd576e + 6a25af9 commit 23c8303
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Expand Up @@ -19,7 +19,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)
Expand Down Expand Up @@ -104,25 +104,20 @@ import (
...
```

### Pinning to the `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.:
### Using `v1` releases

```
$ go get gopkg.in/urfave/cli.v1
$ go get github.com/urfave/cli
```

``` go
```go
...
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

Expand Down

0 comments on commit 23c8303

Please sign in to comment.