diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 84816fa..61b7c0d 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -34,15 +34,28 @@ Then configure the rules you want to use under the rules section. ```json { "rules": { - "opticks/rule-name": 2 + "opticks/toggle": "warn", } } ``` -## Rules - -TODO: Run eslint-doc-generator to generate the rules list. - +For the opticks rules to work, you also need to add your `experiments` configuration settings section. + +```json +{ + "settings": { + "opticks": { + "experiments": { + "foo": "a", + "bar": null, + "baz": "b" + } + } + } +} +``` +## Rules +* `opticks/toggle`: Detects stale code from expired Opticks experiments, and other common mistakes