Add comment about packages and custom rules

Skyscanner · Nov 30, 2023 · e0bc51b · e0bc51b
1 parent b111326
commit e0bc51b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,12 @@ If your project doesn't use it or it is not installed in the same `package.json`
 }
 ```
 
+## Rules included in this repository
+
+Custom rules are currently wrapped in a locally-installed package.
+This will no longer be needed once the eslint version used accepts objects as shown in
+[custom rules tutorial](https://eslint.org/docs/latest/extend/custom-rule-tutorial#step-8-use-the-plugin-locally).
+
 ## Changelog
 
 [View our up-to-date changelog](./CHANGELOG.md).