add docs to readme for pypi direct link

miaucl · Aug 24, 2024 · 93cc953 · 93cc953
1 parent 82b6a8f
commit 93cc953
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -11,6 +11,7 @@
     "memorylimit",
     "memoryused",
     "miaucl",
+    "mkdocs",
     "mosquitto",
     "mqtt",
     "mypy",

diff --git a/README.md b/README.md
@@ -101,6 +101,10 @@ After you start the service (binary) sensors should show up in Home Assistant im
 
 ![Screenshot of Home Assistant sensor showing status and attributes.](https://raw.githubusercontent.com/miaucl/docker2mqtt/master/media/ha_screenshot.png)
 
+## Documentation
+
+Using `mkdocs`, the documentation and reference is generated and available on [github pages](https://miaucl.github.io/docker2mqtt/).
+
 ## Dev
 
 Setup the dev environment using VSCode, it is highly recommended.