From b0c40196b6844f5e8db1551e4722e4e7a0e19d58 Mon Sep 17 00:00:00 2001
From: kjuulh <contact@kjuulh.io>
Date: Sat, 11 Jan 2025 14:11:02 +0100
Subject: [PATCH] docs: add installation docs

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 5f7840e..d2452ed 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
 # churn
+
+## Installation
+
+To install churn, you need first of all a server and agents.
+
+Servers can be run via. docker.
+
+```shell
+docker run docker.io/kjuulh/churn-v2:latest  
+```
+
+To install an agent run the following script
+
+```shell
+curl https://git.front.kjuulh.io/kjuulh/churn-v2/raw/branch/main/install.sh | bash  
+```
+
+configure `~/.local/share/io.kjuulh.churn-agent/churn-agent.toml` use an editor of choice. Churn agent will generate a randomish name for the specific agent, consider giving it something more semantically meaningful to you