Merge pull request #22 from Checkmarx/fix-21

update readme on `fail-on` status
Checkmarx · May 2, 2024 · 765e05d · 765e05d
2 parents 092a183 + 4aa5215
commit 765e05d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/API.md b/API.md
diff --git a/README.md b/README.md
@@ -83,8 +83,10 @@ new KicsValidator({
 });
 ```
 
-The other option is to provide `failureSeverities` if you still want to show
-the query in the results, but you don't want it to fail the execution.
+Alternatively, you can use the `failureSeverities` parameter when initiating a scan, enabling you to precisely define the criteria for considering a scan unsuccessful based on the severity of its results. Any result with a severity lower than the specified ones will not prompt a failure.
+
+Please note that scans configured to only fail on certain severity levels might not display results falling below those specified levels.
+
 By default this is set to `[Severity.HIGH, Severity.MEDIUM]`.
 
 ```ts