From 20ac10c92207de34dfb34e24dfe3a443e661d0de Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Thu, 19 Oct 2023 17:16:41 +0000
Subject: [PATCH] Update README.md

---
 README.md | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 87e7de7..7f9f733 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,14 @@
 
 This script creates the topology data file needed for the [Checkmk Exchange Network visualization](https://forum.checkmk.com/u/schnetz) plugin by Andreas Boesl and [schnetz](https://exchange.checkmk.com/u/schnetz). For more information see [Checkmk forum Network Visualization](https://forum.checkmk.com/t/network-visualization/41680). 
 
+Features:
+- Reading connection data from the Checkmk inventory
+- handling differences between inventory neighbor names and checkmk hostnames
+- Adding user defined connections for connections not included in the inventory
+- optimized for my [CDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/) (default) and [LLDP](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_lldp_cache/) cache plugins
+- can also be used with custom inventory plugins
+- clean up old topologies
+
 The network topology data is read from the Checkmk HW/SW inventory. The necessary inventory data can be created with my CDP/LLDP inventory plugins.
 
 CDP: [CDP inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/)\
@@ -13,16 +21,13 @@ LLDP: [LLDP inventory plugin](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-in
 LLDP path-in-inventory: `"networking,lldp_cache"`\
 LLDP inventory-columns: `"system_name,local_port_num,port_id"`
 
-Usage with CDP (this is the default):
-```
-~/local/lib/topology_data/create_topology_data.py -s Core01 -m
-```
 
-Usage with LLDP:
-```
-~/local/lib/topology_data/create_topology_data.py -s Core01 -m --lldp
 
-```
+---
+### Acknowledgements
+
+Andreas Boesl and schnetz for the Network visualization plugin
+detlev[dot]gerke[at]siegfried[dot]ch, who was my beta tester ;-)
 
 ---
 ### Download
@@ -53,9 +58,23 @@ To use this tool:
 - you need to install/enable an inventory plugin to collect the connection data I.e. my [CDP cache](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/inventory/inv_cdp_cache/) plugin
 - the [Network visualization](https://exchange.checkmk.com/p/network-visualization) must be installed
 
+**Note**: if you are using my CDP/LLDP plugins update at least to version:
+- 0.6.1-20231013 for CDP
+- 0.9.0-20231013 for LLDP
+
 ---
 ### Usage
 
+Usage with CDP (this is the default):
+```
+~/local/lib/topology_data/create_topology_data.py -s Core01 -m
+```
+
+Usage with LLDP:
+```
+~/local/lib/topology_data/create_topology_data.py -s Core01 -m --lldp
+```
+
 <details><summary>Help output from create_topology_data.py -h</summary>
 
 ```
-- 
GitLab