From 3c6e9c9c6b99b6811c871cdf5b81f7d3666d8a79 Mon Sep 17 00:00:00 2001
From: thl-cmk <thl-cmk@outlook.com>
Date: Tue, 10 May 2022 17:36:36 +0000
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0cecfb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Juniper BGP Peer [(Download the MKP package)](/../../../-/raw/master/juniper_bgp_peer.mkp "Download MKP package")
+
+Monitors status of Juniper BGP peers (IPv4 and IPv6)
+---
+
+## Insallation
+
+In addition to this package you need to install the vendor independent plugin [BGP Peer](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer "BGP Peer") as well. 
+
+---
+## Check Info:
+
+* *service*: this check creates one service for each peer/address family/routing instance  (IPv4 and IPv6)
+* *state*: [see bgp_peer states](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer/-/blob/master/README.md "BGP peer readme.md")
+
+* *wato*: [see bgp_peer WATO options](https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_peer/-/raw/master/doc/wato.png?raw=true "BGP Peer WATO options")
+   
+* *perfdata (if avilable)*: 
+    * Prefixes accepted (count)
+    * Prefixes advertised (/s)
+    * Prefixes denied (/s)
+    * Prefixes suppressed (/s)
+    * Prefixes withdrawn (/s)
+    * Updates received (/s)
+    * Updates send (/s)
+    * Total messages received (/s)
+    * Total messages send (/s)
+    * FMS transitions (count)
+    * FMS last change (s)
+    * Last update received (s)
+---
+#### 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")
+
-- 
GitLab