From 1d5a79fd2752cd4ac3a15da6d25bfad710aa6fa7 Mon Sep 17 00:00:00 2001 From: Andreas Hoeffernig Date: Mon, 24 Jan 2022 22:15:41 +0100 Subject: [PATCH] fix(#5): correct rule usage example --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d48ccde..0fb9b8e 100644 --- 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,7 +43,7 @@ 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" }] } } ``` @@ -51,7 +51,7 @@ This rule has an optional object 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?.*" }] } } ```