From 64e8c913251108b9cbf425a6aae37c85f378e411 Mon Sep 17 00:00:00 2001
From: James Read <contact@jread.com>
Date: Thu, 25 Jul 2024 20:57:21 +0100
Subject: [PATCH] Update README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f2446af..6a527df 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,37 @@
-# uncomplicated-alert-receiver
+# uncomplicated-alert-receiver (UAR)
 
 A robust and reliable prometheus alert receiver intended for heads up displays. It works without internet access, external dependencies, configuration files, storage, and generally has very few things to go wrong.
 
-### **This is a No-Nonsense Open Source project;**
+## Installation
+
+UAR is distributed as a Linux container, it can run on any host port, in the example below the port is 1337;
+
+```
+docker run -p 1337:8080 --name uar ghcr.io/jamesread/uncomplicated-alert-receiver
+```
+
+## Setup 
+
+You should already have a prometheus running, as well as an alertmanager running, with at least one alert configured.
+
+Simply, edit your alertmanager.yml to add UAR as a webhook_config. Here is an example, assuming UAR is running at yourServer:8080;
+
+```yaml
+receivers:
+  - name: uar
+    webhook_configs:
+      - url: http://yourServer:8080/alerts
+        send_resolved: false
+
+route:
+  receiver: uar
+  repeat_interval: 30s
+  group_interval: 30s
+```
+
+Of course you are free to set the sending intervals to a duration that fits you. 
+
+## **This is a No-Nonsense Open Source project;**
 
 - All code and assets are Open Source (AGPL).
 - No company is paying for development, there is no paid-for support from the developers.