Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite the "pinning to v1" section. #862

Merged
merged 6 commits into from Aug 17, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 3 additions & 16 deletions README.md
Expand Up @@ -108,25 +108,12 @@ import (
...
```

### Pinning to the `v1` releases
### Using `v1` releases
coilysiren marked this conversation as resolved.
Show resolved Hide resolved

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.
russoj88 marked this conversation as resolved.
Show resolved Hide resolved

```
$ 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.
russoj88 marked this conversation as resolved.
Show resolved Hide resolved

This will pull the latest tagged `v1` release (e.g. `v1.18.1` at the time of writing).

## Getting Started

Expand Down