From d70f9d29f3deeaaad313571da1f9906f9ed41826 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Tue, 10 May 2022 17:04:51 +0000
Subject: [PATCH] Update README.md

---
 README.md | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index d252960..a3a994d 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,18 @@
 
 Check plugin to monitors status of BGP peers and inventory plugin for static BGP peer data.
 
-**NOTE**: This check was originaly from Thomas Wollner (tw[at]wollner-net[dot]de). I have rewritten this for CMK 2.0.
+**NOTE**: This check was originally written by Thomas Wollner (tw[at]wollner-net[dot]de). I have rewritten this for CMK 2.0 and extended it to be the base for all my other BGP plugins.
 
-**NOTE**: this check has become the base for [Cisco BGP peer](https://thl-cmk.hopto.org/gitlab/checkmk/cisco/cisco_bgp_peer) and will soon become the base for [Huawei BGP peer](https://thl-cmk.hopto.org/gitlab/checkmk/huawei/huawei_bgp_peers)
+**NOTE**: this check is the base for [Cisco BGP peer](https://thl-cmk.hopto.org/gitlab/checkmk/cisco/cisco_bgp_peer) and for [Huawei BGP peer](https://thl-cmk.hopto.org/gitlab/checkmk/huawei/huawei_bgp_peers). It will soon become the base for the Juniper BGP peer addon.
 
 ---
-Check Info:
 
-* *service*: creates the service **BGP Peer** with the ip-address of the peer as item
+### Check Info:
+
+* *service*: creates the service **BGP Peer** with the ip-address of the peer as item. Depending on the addon the address family and the VRF/VR will also be used in the item.
+
 ---
+
 * *state*:\
     **critical**: if Peer state is idle or if accepted_prefixes >= prefix_admin_limit\
     **warning**: if Peer state is not idle or not established, if accepted_prefixes >= warn_threshold, if Admin state is not admin start\
@@ -18,7 +21,9 @@ Check Info:
     **critical**: if Peer not found in SNMP data
     
 ---
+
 * *wato*: [see WATO options](/doc/wato.png?raw=true "WATO options")
+
 ---
 * *perfdata (if avilable)*: 
     * in/out updates (/s)
@@ -27,17 +32,24 @@ Check Info:
     * Last update recived (/s)
     * FMS Transitions (count)
 ---
-#### Want to contribute?
+
+### Want to contribute?
 Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")
+
 ---
+
 Sample output
 
 ![sample output](/doc/sample.png?raw=true "sample output")
 
-Sample inventory output
+Sample inventory output (from the cisco_bgp_peer addon)
 
 ![sample inventory output](/doc/sample-inventory.png?raw=true "sample inventory output")
 
-WATO options
+WATO options (check)
+
+![WATO options](/doc/wato.png?raw=true "WATO options (check)")
+
+WATO options (inventory)
 
-![WATO options](/doc/wato.png?raw=true "WATO options")
+![WATO options](/doc/wato-inventory.png?raw=true "WATO options (inventory)")
-- 
GitLab