merge fixes

.github/workflows/publish-pypi.yml

@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/{{ cookiecutter.hyphenated }}
+      url: https://pypi.org/p/netbox-healthcheck-plugin
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
 

CHANGELOG.md

@@ -2,4 +2,9 @@
 
 ## 0.1.2 (2024-04-05)
 
+* General cleanup
+
+## 0.1.0 (2023-01-18)
+
 * First release on PyPI.
+

README.md

@@ -2,6 +2,9 @@
 
 NetBox plugin for HealthCheck.
 
+NetBox provides health check monitors that can be queried to make sure that the service is running in good condition.  
+
+NetBox exposes metrics at the `/healthcheck` HTTP endpoint, e.g. `https://netbox.local/healthcheck`. It allows monitor conditions via HTTP(S), with responses available in HTML and JSON formats.
 
 * Free software: Apache-2.0
 * Documentation: https://netbox-community.github.io/netbox-healthcheck-plugin/
@@ -15,7 +18,8 @@ The features the plugin provides should be listed here.
 
 | NetBox Version | Plugin Version |
 |----------------|----------------|
-|     3.4        |      0.1.0     |
+|   3.4 - 3.7    |      0.1.0     |
+|   3.4 - 3.7    |      0.1.2     |
 
 ## Installing
 
@@ -39,14 +43,18 @@ Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
 
 ```python
 PLUGINS = [
-    'HealthCheck'
+    'netbox_healthcheck_plugin'
 ]
 
 PLUGINS_CONFIG = {
-    "HealthCheck": {},
+    "netbox_healthcheck_plugin": {},
 }
 ```
 
+## Setting up Monitoring
+
+NetBox makes use of the [django-health-check](https://github.com/revsys/django-health-check) library, more information on setting up monitors can be found at [Setting up Monitoring](https://django-health-check.readthedocs.io/en/latest/readme.html#setting-up-monitoring):
+
 ## Credits
 
 Based on the NetBox plugin tutorial: