Merge pull request #6 from bamboechop/bugfix/#5-improve-readme

fix(#5): correct rule usage example
bamboechop · Jan 24, 2022 · 0db49c3 · 0db49c3
2 parents d85df9c + 1d5a79f
commit 0db49c3
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ Then configure the rules you want to use under the rules section.
 ```json
 {
     "rules": {
-        "jira-ticket-todo-comment/rule-name": "error"
+        "jira-ticket-todo-comment/jira-ticket-todo-comment": "error"
     }
 }
 ```
@@ -43,15 +43,15 @@ This rule has an optional object option.
 ```json
 {
     "rules": {
-        "jira-ticket-todo-comment/rule-name": ["error", { "projectKey":  "TP" }]
+        "jira-ticket-todo-comment/jira-ticket-todo-comment": ["error", { "projectKey":  "TP" }]
     }
 }
 ```
 * `"regex": "^TODO\\s[A-Z]_[A-Z]{1,9}-\\d+\\s?.*"` (default `^TODO\\s[A-Z]{2,255}-\\d+(\\s.*)?`) allows you to override the default regex which is used to check for the JIRA ticket format; can **NOT** be set together with `"projectKey"` option
 ```json
 {
     "rules": {
-        "jira-ticket-todo-comment/rule-name": ["error", { "regex":  "^TODO\\s[A-Z]_[A-Z]{1,9}-\\d+\\s?.*" }]
+        "jira-ticket-todo-comment/jira-ticket-todo-comment": ["error", { "regex":  "^TODO\\s[A-Z]_[A-Z]{1,9}-\\d+\\s?.*" }]
     }
 }
 ```