Skip to content

Commit 351bb12

Browse files
authored
updates installation instructions (#562)
1 parent 2855950 commit 351bb12

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ Here's how `revive` is different from `golint`:
6262
<!-- TOC -->
6363

6464
- [revive](#revive)
65+
- [Installation](#installation)
6566
- [Usage](#usage)
6667
- [Bazel](#bazel)
6768
- [Text Editors](#text-editors)
6869
- [Continuous Integration](#continuous-integration)
6970
- [Linter Aggregators](#linter-aggregators)
7071
- [golangci-lint](#golangci-lint)
71-
- [Installation](#installation)
7272
- [Command Line Flags](#command-line-flags)
7373
- [Sample Invocations](#sample-invocations)
7474
- [Comment Annotations](#comment-annotations)
@@ -99,6 +99,19 @@ Here's how `revive` is different from `golint`:
9999

100100
<!-- /TOC -->
101101

102+
## Installation
103+
104+
```bash
105+
go install github.com/mgechev/revive@latest
106+
```
107+
108+
or get a released executable from the [Releases](https://github.com/mgechev/revive/releases) page.
109+
110+
You can install the main branch (including the last commit) with:
111+
```bash
112+
go install github.com/mgechev/revive@master
113+
```
114+
102115
## Usage
103116

104117
Since the default behavior of `revive` is compatible with `golint`, without providing any additional flags, the only difference you'd notice is faster execution.
@@ -163,12 +176,6 @@ The [Configuration](#configuration) section of this document provides details on
163176

164177
Please notice that if no particular configuration is provided, `revive` will behave as `go-lint` does, i.e. all `go-lint` rules are enabled (the [Available Rules table](#available-rules) details what are the `go-lint` rules). When a configuration is provided, only rules in the configuration are enabled.
165178

166-
### Installation
167-
168-
```bash
169-
go get -u github.com/mgechev/revive
170-
```
171-
172179
### Command Line Flags
173180

174181
`revive` accepts three command line parameters:

0 commit comments

Comments
 (0)