From 7f72737b4034e0ba941f7a11edb987522f54bf71 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Sat, 3 Jun 2023 17:45:54 +0000
Subject: [PATCH] Update README.md
---
README.md | 32 ++++++++++++++++++++++++--------
1 file changed, 24 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 434e5ad..f0f39f0 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,44 @@
-# STP topology change [(Download the MKP package)](/../../../-/raw/master/stp_topo_change.mkp "Download MKP package")
+# STP topology change
Monitors status of STP topology change
-This is a rewrite for CMK 2.0 based on the check "Cisco Spanning-Tree Topology Change" (cisco_stptopo) by Udo Woehler (check-mk at bsw-com.de).
+This is a rewrite for CMK 2.x based on the check **Cisco Spanning-Tree Topology Change** (cisco_stptopo) by Udo Woehler (check-mk[at]bsw-com[dot]de).
---
-Check Info:
+### Check Info
* *service*: creates the service **STP topology change**
----
+
* *state*: \
**critical**/**warning**:
* if there are tree or more STP topology changes in the configured interval (see WATO)\
----
+
* *wato*: [(see WATO options)](doc/wato.png "see sample screenshot")
----
+
* *perfdata (if avilable)*:
* STP topology change (s)
* STP topology changes (count)
+
+---
+### Download
+
+* [stp_topo_change.mkp (latest version)](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/stp_topo_change/-/raw/master/stp_topo_change.mkp "Download latest version")
+
+---
+### Installation
+
+You can install the package by uploading it to your CheckMK site and as site user run `mkp install stp_topo_change.mkp`.
+
+
+In the Enterprise/Free edition of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)
+
---
-#### Want to contribute?
+### Want to contribute?
+
Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
+
---
-Sample output
+### Sample output
--
GitLab