diff --git a/CHANGELOG.md b/CHANGELOG.md index e94b588..eb3e715 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## 1.0.1 + +- Fix SDK version. +- Enhance README. + ## 1.0.0 - Add linst according to current state of the Effective Dart `analysis_options.yaml`. diff --git a/README.md b/README.md index c967952..b5edd01 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,11 @@ [![pub package](https://img.shields.io/pub/v/effective_dart.svg)](https://pub.dartlang.org/packages/effective_dart) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) -This package provides the lints according to the [Effective Dart](https://dart.dev/guides/language/effective-dart) guide. +This package provides links that attempt to comply with all [*Effective Dart*](https://dart.dev/guides/language/effective-dart) guide rules. -This package is inspired by the [pedantic](https://github.com/dart-lang/pedantic) package, which contains lints internally used at Google. +**Be consistent. Be brief.** + +> *Note*: This package is inspired by the [pedantic](https://github.com/dart-lang/pedantic) package, which contains lints internally used at Google. ## Using the Lints @@ -30,12 +32,20 @@ include: package:effective_dart/analysis_options.1.0.0.yaml ## Unused Lints -The following lints have been considered and will not be enforced: +Following lints have been considered and will not be enforced by this package: -`lines_longer_than_80_chars` might be practical to not follow this rule sometimes for many people. +`lines_longer_than_80_chars` might be practical not to follow for many people. `unnecessary_getters` has been [disabled](https://github.com/dart-lang/linter/issues/23). +## Badge + +Show the world you're following the *Effective Dart* guide → [![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) + +```md +[![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) +``` + ## License Licensed under the [MIT License](LICENSE). diff --git a/pubspec.yaml b/pubspec.yaml index fe125ad..04de41e 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -4,6 +4,7 @@ version: 1.0.1 author: Honza Bittner repository: https://github.com/tenhobi/effective_dart issue_tracker: https://github.com/tenhobi/effective_dart/issues +homepage: https://github.com/tenhobi/effective_dart environment: sdk: ">=2.0.0 <3.0.0"