Update README.md

[mit-mit]

Fixes dart-lang/core#841

[pq]

fyi @devoncarew; I think the template currently is using core? (https://dart-review.googlesource.com/c/sdk/+/198620)

[pq]

Should we change this to core or update the template?

/cc @devoncarew @mit-mit

[devoncarew]

Good catch - this is not in sync w/ what dart create does. I believe that it was decided to use core - what pub scores with - but was not in that particular conversation.

[goderbauer]

My vote is for updating dart create to push people towards the recommended set. There are a lot of good lints in there. It would also align a little closer with flutter since flutter_lints builds on top of recommended.

[mit-mit]

Let's keep that as a separete issue; no need to block this readme update on that. I've made the text here more general.

I'll share a doc with some analysis for making the choice regarding dart create.

[mit-mit]

Tracking issue: https://github.com/dart-lang/lints/issues/20

[devoncarew]

In this readme, we should also include the fact that you need to add a dev. dependency on lints to your pubspec (w/ a small sample snippet) and a sample of a simple analysis_options file. Perhaps in a 'how to use' section?

## How to use

Add a dev dependency on this package to your `pubspec.yaml` file:

``yaml
dev_dependencies:
  lints: ^1.0.0
``

And create a new `analysis_options.yaml` file, next to the pubspec, that includes the lints package:

``yaml
include: package:lints/core.yaml
``

[mit-mit]

In this readme, we should also include the fact that you need to add a dev. dependency on lints to your pubspec (w/ a small sample snippet) and a sample of a simple analysis_options file. Perhaps in a 'how to use' section?

Good idea; added

[devoncarew]

lgtm modulo reconciling the the item that Phil found; we should update this readme or the behavior of dart create.

[devoncarew]

Good catch - this is not in sync w/ what dart create does. I believe that it was decided to use core - what pub scores with - but was not in that particular conversation.