diff --git a/README.md b/README.md
index 506d799..a85ad48 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,11 @@
|
+
+
+
+
+ |
@@ -24,18 +29,23 @@
- around 80 opnsense scripts you can call
- automatically configures your Vlan and Phy Interfaces after applying configuration
+---
+
+- ***[pypy project](https://pypi.org/project/opnsense-helper)***
+- ***[Api Docs](https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html)***
+
+---
## install
-### pip
+
+### pip
```bash
pip install opnsense-helper
```
+
## usage
+
> - you can run the provided snippets directly by pulling the [example file](https://github.com/the-pod-shop/opnsense-helper/blob/main/python/examples/add_vlans.py)
-> - Please also have a look at:
-> - the [Api Docs](https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html)
-> - the corresponding [pip package](https://pypi.org/project/opnsense-helper/)
-> - and soon also the Ansible collection.
### required variables
* import the package and define the needed variables for the main class