diff --git a/README.md b/README.md index cd51550..30026d2 100644 --- a/README.md +++ b/README.md @@ -23,30 +23,40 @@ All credit should go to Jeremy. Thanks, Jeremy! This project just looks to build on top of this framework and model presented. +## Contributing + +This project is currently maintained jointly by: + +* [Abhimanyu Saharan](https://github.com/abhi1693) +* [Ryan Merolle](https://github.com/ryanmerolle) + +See the [CONTRIBUTING](CONTRIBUTING.md) for more information. + ## Compatibility -This plugin was first developed using 3.2.5, and tested with all of 3.2. +Each Plugin Version listed below has been tested with its corresponding NetBox Version. | NetBox Version | Plugin Version | |----------------|----------------| | 3.2 | 1.0.1 | | 3.3 | 1.1.0 | +| 3.4 | Coming Soon | ## Installing For adding to a NetBox Docker setup see [the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins). -While this is still in development and not yet on pypi you can install with pip: +You can install with pip: ```bash -pip install git+https://github.com/ryanmerolle/netbox-acls.git@dev +pip install netbox-acls ``` or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker): ```bash -git+https://github.com/ryanmerolle/netbox-acls.git@dev +netbox-acls ``` Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,