From 8e3af9a3c3fb451729935cc34f7290e7a97a0833 Mon Sep 17 00:00:00 2001
From: Jonny007-MKD <me@jonny007-mkd.de>
Date: Sat, 29 Feb 2020 16:57:37 +0100
Subject: [PATCH] Added README.md

---
 README | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..b300d55
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+# check_nmap.sh
+This script runs a nmap scan and checks the discovered ports against a whitelist
+
+## Arguments
+* --host  | -h: Host that shall be scanned by nmap
+* --portrange | -p: Ports that shall be scanned (nmap format)
+* --known | -k: A port number that is expected to be open
+* --input | -i: Use input file instead of a real nmap scan (for testing)
+* --debug | -d: More debugging output, cannot be used with icinga2
+* all arguments after -- are passed to nmap
+
+## Results
+* CRITICAL: if any expected port is open