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 |