From ac853eeda9225d75d5915f9d3b908221a5ffc25a Mon Sep 17 00:00:00 2001
From: XiCoN-FJS- <fjs@xicon.de>
Date: Mon, 23 Nov 2020 00:31:02 +0100
Subject: [PATCH] init README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9aed46c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# check_online_status
+
+Icinga/Nagios nrpe check script testing online reachability.
+
+## Install guide (Debian >= 9.0)
+Install required packages
+```
+$ apt-get install libnet-interface-perl libnet-subnet-perl libnet-oping-perl liboping0 
+```
+
+## Usage guide
+command line options
+```
+./check_online_status --src-dev=<ethX> --target=<8.8.8.8> [--target=<2001:4860:4860::8888> ...] [--src-ip=<203.0.113.1|2001:db8::1>] [--family=<AF_INET|AF_INET6>] [--allow-rfc1918] [--allow-rfc4193] [--enable-warning]
+```