1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..90220e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# nanostatus
+
+A minimal service status page generator. It runs shell commands to check if your services are up, records the results, and generates a static HTML page showing uptime over the last 30 days.
+
+## Quick start
+
+Install Python 3 if you don't have it:
+
+```sh
+pkg install python3
+```
+
+Clone the repo and copy the example config:
+
+```sh
+git clone https://github.com/yourname/nanostatus
+cd nanostatus
+cp example.ini status.ini
+```
+
+Edit `status.ini` to add your services. Each service needs a name, a shell command that returns 0 on success, and optionally a URL:
+
+```ini
+[service:mysite]
+url = https://example.com
+cmd = curl --fail https://example.com
+```
+
+Run it:
+
+```sh
+python3 nanostatus.py -c status.ini
+```
+
+This writes check results to `./` and generates `./html/status.html`. To run it on a schedule, add a cron job:
+
+```sh
+crontab -e
+```
+
+```
+*/5 * * * * cd /path/to/nanostatus && python3 nanostatus.py -c status.ini
+```
+
+Serve `html/status.html` with any web server (nginx, caddy, etc.).