Skip to content

Commit

Permalink
docs: update README to use v3.1.0 (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
felangel committed Sep 19, 2022
1 parent 3f0eb08 commit baf0da6
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Expand Up @@ -18,16 +18,11 @@ This package provides lint rules for Dart and Flutter which are used at [Very Go

## Usage

To use the lints, add a dependency in your `pubspec.yaml`:
To use the lints, add as a dev dependency in your `pubspec.yaml`:

```yaml
# If you use `package:very_good_analysis/very_good_analysis.dart`, add a normal dependency.
dependencies:
very_good_analysis: ^3.0.2

# Or, if you just want `analysis_options.yaml`, it can be a dev dependency.
dev_dependencies:
very_good_analysis: ^3.0.2
very_good_analysis: ^3.1.0
```

Then, add an include in `analysis_options.yaml`:
Expand All @@ -39,7 +34,7 @@ include: package:very_good_analysis/analysis_options.yaml
This will ensure you always use the latest version of the lints. If you wish to restrict the lint version, specify a version of `analysis_options.yaml` instead:

```yaml
include: package:very_good_analysis/analysis_options.3.0.1.yaml
include: package:very_good_analysis/analysis_options.3.1.0.yaml
```

## Suppressing Lints
Expand Down

0 comments on commit baf0da6

Please sign in to comment.