Add score to instructions

rcraggs · Jul 30, 2018 · ee246b7 · ee246b7
1 parent 5f77778
commit ee246b7
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.MD b/README.MD
@@ -85,3 +85,4 @@ The following options can be added to any rule to affect its behaviour or the ou
 - `failure-message`: A specific message if the rule fails. e.g. "Did you remember to commit the file?"
 - `alternative-title`: An alternative description of the rule to appear in the output. e.g. "You created the repository"
 - `stop-on-fail`: Causes all following rules to be skipped if this one fails. Good if other rules make no sense if a prior one fails.
+- `score-if-correct`: Allocate a score for this rule which will be shown in the output. The final score will also be shown if there is one.