diff --git a/README.md b/README.md index 43f5698b..dbeee95a 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,10 @@ An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and Type * [Installation](#Installation) * [Usage](#Usage) -* [Supported Rules](#SupportedRules) -* [Supported Presets](#SupportedPresets) +* [Rules](#Rules) +* [Presets](#Presets) + * [Semantic versioning policy](#Semanticversioningpolicy) + * [Preset usage](#Presetusage) -## Supported Presets +## Presets | | Name | Description | |:--|:-----|:------------| @@ -96,8 +98,12 @@ Name | ✔️ | 🛠 | 💡 | Description | | `rules` | enables all rules that are aimed at linting ESLint rule files | | | `tests` | enables all rules that are aimed at linting ESLint test files | +### Semantic versioning policy + The list of recommended rules will only change in a major release of this plugin. However, new non-recommended rules might be added in a minor release of this plugin. Therefore, the using the `all`, `rules`, and `tests` presets is **not recommended for production use**, because the addition of new rules in a minor release could break your build. +### Preset usage + Presets are enabled by adding a line to the `extends` list in your config file. For example, to enable the `recommended` preset, use: ```json