From 15f05fc1228b5c2bb81d70c67385cb3dac7d51e0 Mon Sep 17 00:00:00 2001
From: JanHoefelmeyer <107021473+JanHoefelmeyer@users.noreply.github.com>
Date: Mon, 11 Jul 2022 12:30:57 +0200
Subject: [PATCH] Adds explanation of type returns of individual checkers to
 csaf_checker.md (#215)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Jan Höfelmeyer <Jan Höfelmeyer jhoefelmeyer@intevation.de>
---
 docs/csaf_checker.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md
index 9a342c8..bcfe8e8 100644
--- a/docs/csaf_checker.md
+++ b/docs/csaf_checker.md
@@ -22,3 +22,12 @@ Help Options:
 
 Usage example:
 ` ./csaf_checker example.com -f html --rate=5.3 -o check-results.html`
+
+Each performed check has a return type of either 0,1 or 2:
+```
+type 0: success
+type 1: warning
+type 2: error
+```
+
+The checker result is a success if no checks resulted in type 2, and a failure otherwise.