From 0d23cf551e3605acc57175eceabfaafccf1ded5c Mon Sep 17 00:00:00 2001 From: Honza Bittner Date: Thu, 24 Oct 2019 22:34:14 +0200 Subject: [PATCH 1/2] Add badge --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c967952..5d2e8a6 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 → [![follows: effective dart](https://img.shields.io/badge/follows-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) + +```md +[![follows: effective dart](https://img.shields.io/badge/follows-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) +``` + ## License Licensed under the [MIT License](LICENSE). From 0dbe4c58564324bf07c7f412fb22bbd3b0690bb0 Mon Sep 17 00:00:00 2001 From: Honza Bittner Date: Thu, 24 Oct 2019 23:22:14 +0200 Subject: [PATCH 2/2] Rename badge 'follows' to 'style' --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d2e8a6..b5edd01 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,10 @@ Following lints have been considered and will not be enforced by this package: ## Badge -Show the world you're following the *Effective Dart* guide → [![follows: effective dart](https://img.shields.io/badge/follows-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) +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 -[![follows: effective dart](https://img.shields.io/badge/follows-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) +[![style: effective dart](https://img.shields.io/badge/style-effective_dart-40c4ff.svg)](https://github.com/tenhobi/effective_dart) ``` ## License