From fb23c5f327b41898fd17373670e9b6424102c777 Mon Sep 17 00:00:00 2001
From: "Markus F.J. Busche" <elpatron@mailbox.org>
Date: Sat, 3 Feb 2024 12:30:38 +0100
Subject: [PATCH] Update README

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 426b245..02e5d64 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,26 @@
-# Uptime-Kuma SMTP bridge
+# Uptime-Kuma SNMP bridge for QNAP Disk Helth Checks
+
+Checks (QNAP-) disk status by *snmpwalk* and returns HTML output and status code for [Uptime Kuma](https://github.com/louislam/uptime-kuma).
+
+## Docker Run
+
+`docker run -d -p 8684:8684 elpatron68/uptimekuma-snmp-bridge`
+
+## Supported Checks
+
+| Name | OID | Path |
+| -- |-- |-- |
+| S.M.A.R.T | `.1.3.6.1.4.1.24681.1.2.11.1.7` | `/check-qnap-disk-smart` |
+| Disk Status | `.1.3.6.1.4.1.24681.1.2.11.1.4` | `/check-qnap-status` |
+| Volume Status | `.1.3.6.1.4.1.24681.1.2.17.1.6.1` | `/check-volume-status` |
+
+## Uptime-Kuma
+
+Add a *HTTP(s) - Keyword* check in Uptime-Kuma with URL
+
+`http://<host-ip of Uptime-Kuma SNMP bridge>:<Port>/check-qnap-status?ip=<IP of your QNAP NAS>`
+
+Keyword: `Healthy: True`
 
 ## Docker