From 333461fd2a2708fe48a8bccede3a6d684143b93c Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Sat, 4 Dec 2021 12:52:39 +0000
Subject: [PATCH] Update README.md

---
 README.md | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 96e69f6..60c117a 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,32 @@
-# Cisco NTP [(Download the MKP package)](/../../../-/raw/master/{REPLACE_WITH_PACKAGE_NAME}.mkp "Download MKP package")
+# Extended traceroute plugin [(Download the MKP package)](/../../../-/raw/master/active_check_traceroute.mkp "Download MKP package")
+
+This is a extension for the original CheckMK traceroute plugin (Routing)
+
+it adds the following options:
+
+- service description suffix
+- alternate destination address
+- destination port for UDP/TCP path trace
+- max hops
+- queries per hop
+- source address
+- source interface (needs root permissions)
+- perfometer
+
+**Note: Source address and source interface uses the "shell=True" option in in the "subprocess.Popen" command. This is highly insecure, so be careful.**
+
+**Note**: the original TCP path trace option also needs root permisions.
 
-Monitors status of C{REPLACE_WITH_PACKAGE_TITLE}
 ---
 Check Info:
 
-* *service*: creates the service **_NTP status_** and one service **_NTP {item}_** for each NTP association, with the association name/ip-address as item
+* *service*: creates the service **_Routing {item}_** with optional suffix as item
 ---
-* *state*: \
-    **warning**: 
-    * if NTP refID is in AUTH, AUTO, CRYPT, DENY, INIT, LOCL, RATE, STEP, TIME or XFAC (see WATO)
-    * if Error counter > 0 (see WATO)
-
-    **critical**/**warning**: 
-    * if offset or stratum outside the configured levels (see WATO)\
+* *state*: see original plugin
 ---
 * *wato*: [(see WATO options)](/../../../-/raw/master/doc/wato.png "see sample screenshot")
 ---
-* *perfdata (if avilable)*: 
-    * Offset (s)
-    * Delay (s)
-    * Jitter (s)
-    * Protocol errors (/s)
-    * Version errors (/s)
----
-#### Want to contribute?
-Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
+* *perfdata*: see original plugin
 ---
 Sample output
 
-- 
GitLab