From 2248a39e5f2baf33099e232abaf79526a528876c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Eberhardt?= <hello+code@cedeber.fr>
Date: Sat, 7 Sep 2024 22:55:00 +0200
Subject: [PATCH] add quick doc for first rule

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 5d0d97f..7761f32 100644
--- 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 |