Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ji-podhead authored Nov 13, 2024
1 parent cd5e874 commit d5e6731
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
<td>
<img alt="Static Badge" src="https://img.shields.io/badge/Ansible%20Collection-%F0%9F%9A%A7-darkgrey?style=for-the-badge&color=red">
</td>
<td>
<a href="https://github.com/ji-podhead/opnsense-helper/">
<img alt="Static Badge" src="https://img.shields.io/badge/open%20source-blue?style=for-the-badge&logo=github">
</a>
</td>
</tr>
</table>

Expand All @@ -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
Expand Down

0 comments on commit d5e6731

Please sign in to comment.