Update README.md

README.md

@@ -72,6 +72,50 @@ There is no service discovery rule
 There is no inventory rule.
 </details> 
 
+---
+### Usage
+<details><summary>Help output from check_bgp_topology --help</summary>
+
+```
+OMD[build]:~$ ~/local/lib/python3/cmk_addons/plugins/bgp_topology/libexec/check_bgp_topology --help
+usage: bgp_topology [-h] [--bgp-anchor {both,as,id,none}] [--bgp-emblem-as BGP_EMBLEM_AS] [--bgp-emblem-id BGP_EMBLEM_ID] [--make-default] --host HOST [--include-sites INCLUDE_SITES [INCLUDE_SITES ...] | --exclude-sites EXCLUDE_SITES [EXCLUDE_SITES ...]] [--debug]
+
+Create BGP peer network topology for Checkmk
+
+options:
+  -h, --help            show this help message and exit
+  --bgp-anchor {both,as,id,none}
+                        Anchor for external BGP objects (default: both).
+  --bgp-emblem-as BGP_EMBLEM_AS
+                        Emblem to use for BGP-AS objects (default: icon_cloud).
+  --bgp-emblem-id BGP_EMBLEM_ID
+                        Emblem to use for BGP-ID objects (default: icon_topic_system).
+  --make-default        Make this topology the default (default: False).
+  --host HOST           The name of the Checkmk host to which the plugin is attached. This is set 
+                        automatically by Checkmk. If a site filter is active, the host name is 
+                        appended to the subdirectory where the topology is stored (“BGP” becomes 
+                        “BGP_host_name”). This way we can have more than one BGP topology without 
+                        overwriting each other.
+  --include-sites INCLUDE_SITES [INCLUDE_SITES ...]
+                        List of Checkmk site names to include in the topology creation. 
+                        Can not used together with --exclude-sites
+  --exclude-sites EXCLUDE_SITES [EXCLUDE_SITES ...]
+                        List of Checkmk site names to exclude from the topology creation. 
+                        Can not used together with --include-sites
+  --debug               enable debug output
+
+Example usage:
+~/local/lib/python3/cmk_addons/plugins/bgp_topology/libexec/check_bgp_topology --make-default --host bgp1        
+
+Version: 0.0.2-20241223 | Written by thl-cmk[at]outlook[dot]com
+for more information see: https://thl-cmk.hopto.org/gitlab/checkmk/vendor-independent/bgp_topology
+        
+OMD[build]:~$ 
+
+```
+
+</details>
+
 ---
 ### Sample Output