add quick doc for first rule

cedeber · Sep 7, 2024 · 2248a39 · 2248a39
1 parent e661a3c
commit 2248a39
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
 # eslint-plugin-throw
 
 ESLint plugin to enforce function naming and JSDoc annotations for functions that throw
+
+## Rules
+
+| Name                | Description                                                   |
+| :------------------ | :------------------------------------------------------------ |
+| throw-documentation | Enforce JSDoc @throws tag for functions that throw exceptions |