diff --git a/packages/wyatt_analysis/README.md b/packages/wyatt_analysis/README.md index 58d79103..b403cf66 100644 --- a/packages/wyatt_analysis/README.md +++ b/packages/wyatt_analysis/README.md @@ -20,7 +20,7 @@ ![SDK: Dart & Flutter](https://img.shields.io/badge/SDK-Dart%20%7C%20Flutter-blue?style=flat-square) -This package provides lint rules for Dart and Flutter which are used at [Wyatt](https://wyattapp.io) and [Wyatt Studio](https://wyatt-studio.fr). For more information, see the complete list of options in **lib/analysis_options.1.1.1.yaml**. +This package provides lint rules for Dart and Flutter which are used at [Wyatt](https://wyattapp.io) and [Wyatt Studio](https://wyatt-studio.fr). For more information, see the complete list of options in **lib/analysis_options.2.0.0.yaml**. **Note**: This package was heavily inspired by [pedantic](https://github.com/dart-lang/pedantic), [Very Good Analysis](https://github.com/VeryGoodOpenSource/very_good_analysis) and the official [flutter_lints](https://pub.dev/packages/flutter_lints). @@ -29,20 +29,11 @@ This package provides lint rules for Dart and Flutter which are used at [Wyatt]( To use the lints, add a dependency in your `pubspec.yaml`: ```yaml -# If you use `package:wyatt_analysis/wyatt_analysis.dart`, add a normal dependency, you'll get unawaited function. -dependencies: - wyatt_analysis: - git: - url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages - ref: v1.1.1 - path: packages/wyatt_analysis - -# Or, if you just want `analysis_options.yaml`, it can be a dev dependency. dev_dependencies: wyatt_analysis: git: url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages - ref: v1.1.1 + ref: wyatt_analysis-v2.0.0 path: packages/wyatt_analysis ``` @@ -61,13 +52,13 @@ include: package:wyatt_analysis/analysis_options.flutter.yaml If you wish to restrict the lint version, specify a version of `analysis_options.yaml` instead: ```yaml -include: package:wyatt_analysis/analysis_options.flutter.1.1.1.yaml +include: package:wyatt_analysis/analysis_options.flutter.2.0.0.yaml ``` If you just want **Dart** version: ```yaml -include: package:wyatt_analysis/analysis_options.1.1.1.yaml +include: package:wyatt_analysis/analysis_options.2.0.0.yaml ``` ## Suppressing Lints @@ -110,8 +101,12 @@ linter: ## Badge -To indicate your project is using `wyatt_analysis` → [![style: wyatt analysis](https://img.shields.io/badge/Style-Wyatt%20Analysis-blue)](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt_analysis) +To indicate your project is using `wyatt_analysis` → [![style: wyatt analysis](https://img.shields.io/badge/Style-Wyatt%20Analysis-blue)](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis) ```md -[![style: wyatt analysis](https://img.shields.io/badge/Style-Wyatt%20Analysis-blue)](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt_analysis) +[![style: wyatt analysis](https://img.shields.io/badge/Style-Wyatt%20Analysis-blue)](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis) ``` + +## Notes + +You can explore every lint rules [here](https://dart-lang.github.io/linter/lints/). \ No newline at end of file