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.

Sign up for GitHub

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

Jump to bottom

docs: update README to use 3.1.0 #57

Merged
merged 1 commit into from Sep 19, 2022
Merged

docs: update README to use 3.1.0 #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
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