From d8c08778f941a459fccae932e3768f9b9fe1783d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Torjus=20H=C3=A5kestad?= <torjus@usit.uio.no>
Date: Mon, 9 Mar 2026 19:07:46 +0100
Subject: [PATCH] Improve README with configuration, build, and usage info

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 85d191f..4c5fe70 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,27 @@
-# Alert-to-notify
+# alerttonotify
 
-Receives HTTP requests from alertmanager. Sends to DBUS notify.
+Receives Alertmanager webhook notifications and forwards them via NATS to a dbus notification service.
 
-# Usage
+## Configuration
 
-TODO
+All configuration is via environment variables:
 
+| Variable | Required | Description |
+|---|---|---|
+| `NATS_URL` | Yes | NATS server URL |
+| `NATS_NKEY` or `NATS_NKEY_FILE` | Yes | NKey seed for NATS authentication |
+| `ALERTTONOTIFY_ADDR` | No | HTTP listen address (default `:5001`) |
+
+## Building
+
+```bash
+# With Go
+go build -v ./...
+
+# With Nix
+nix build
+```
+
+## Usage
+
+Point an Alertmanager webhook receiver at `http://<host>:5001/alert`.