From 58d67265eec1dcc7aa8eeb2c3e2a7b344124cee2 Mon Sep 17 00:00:00 2001
From: Gerrit Burger <gerrit@findhotel.net>
Date: Thu, 28 Mar 2024 15:55:33 +0100
Subject: [PATCH] Update README with further installation instructions and
 available rules

---
 packages/eslint-plugin/README.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

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
 
-<!-- begin auto-generated rules list -->
-TODO: Run eslint-doc-generator to generate the rules list.
-<!-- end auto-generated 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