Skip to content

Commit

Permalink
updates installation instructions (#562)
Browse files Browse the repository at this point in the history
  • Loading branch information
chavacava authored Aug 17, 2021
1 parent 2855950 commit 351bb12
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ Here's how `revive` is different from `golint`:
<!-- TOC -->

- [revive](#revive)
- [Installation](#installation)
- [Usage](#usage)
- [Bazel](#bazel)
- [Text Editors](#text-editors)
- [Continuous Integration](#continuous-integration)
- [Linter Aggregators](#linter-aggregators)
- [golangci-lint](#golangci-lint)
- [Installation](#installation)
- [Command Line Flags](#command-line-flags)
- [Sample Invocations](#sample-invocations)
- [Comment Annotations](#comment-annotations)
Expand Down Expand Up @@ -99,6 +99,19 @@ Here's how `revive` is different from `golint`:

<!-- /TOC -->

## Installation

```bash
go install github.com/mgechev/revive@latest
```

or get a released executable from the [Releases](https://github.com/mgechev/revive/releases) page.

You can install the main branch (including the last commit) with:
```bash
go install github.com/mgechev/revive@master
```

## Usage

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

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.

### Installation

```bash
go get -u github.com/mgechev/revive
```

### Command Line Flags

`revive` accepts three command line parameters:
Expand Down

0 comments on commit 351bb12

Please sign in to comment.