From 93cc953370d83effe6336731a831a64f67465859 Mon Sep 17 00:00:00 2001
From: Cyrill Raccaud <cyrill.raccaud@aposphere.com>
Date: Sat, 24 Aug 2024 11:15:40 +0200
Subject: [PATCH] add docs to readme for pypi direct link

---
 .vscode/settings.json | 1 +
 README.md             | 4 ++++
 2 files changed, 5 insertions(+)

diff --git a/.vscode/settings.json b/.vscode/settings.json
index cb5b8c2..246faae 100644
--- 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
index f2296d4..763caa1 100755
--- 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.