From 1aca11232f3ea56e1400447a586075fa888d3cec Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Mon, 14 Jun 2021 12:42:19 +0000
Subject: [PATCH] Add README.md

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b96196c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Qualys SSL Labs REST API special agent
+
+**Note: this package is for CheckMK version 2.x.**
+
+This Agent uses die Qualys SSL Lab REST API.  For details about the API see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs-v3.md. To check a server manually go to https://www.ssllabs.com/ssltest/index.html.
+
+
+
+Check Info:
+
+* *services*: this check creates on service for each SSL server to check
+* *state*: 
+    * the check will go 'warn', 'crit' or 'ok' depending on the SSL server overall rating
+    * the check will go 'warn', 'crit' or 'ok' depending on the laste time the SSL server check was running
+    * the check will go 'warn' if the SSL server test is running
+    * the check will go 'crit' on API errors
+    * the check will go 'unknown' if the SSL server check has an unknown outcome.
+
+* *wato*:
+    * Overall rating and last run can be configured
+
+* *perfdata*: none 
+
+Sample output
+![Sample](/doc/sample.png?raw=true "sample [SHORT TITLE]")
+
+Sample wato
+![wato](/doc/wato.png?raw=true "wato [SHORT TITLE]")
+
+
+Sample agent output
-- 
GitLab