From 0607de2dac9a57babc0da884a4d28bd6d9da4372 Mon Sep 17 00:00:00 2001
From: erik <erik.seiert@meissa-gmbh.de>
Date: Fri, 23 Dec 2022 16:02:30 +0100
Subject: [PATCH] [Skip-CI] Update Readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0da9b0c..e12ed73 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,32 @@
 
 ## Purpose
 
-c4k-common ....
+c4k-common provides the foundation for all our c4k modules.
+
+It is now possible to generate a working prometheus monitoring file in yaml format.
+Your config.edn and your auth.edn should at least contain the following fields:
+
+config.edn - minimal example
+
+```clojure
+{:k3s-cluster-name "your-cluster-name"
+ :k3s-cluster-stage :prod
+ :grafana-cloud-url "your-url"}
+```  
+
+auth.edn - minimal example  
+
+```clojure
+{:grafana-cloud-user "user"
+ :grafana-cloud-password "password"}
+```  
+
+call (with jarwrapper installed):  
+
+```bash
+c4k-common-standalone.jar config.edn auth.edn > monitoring.yaml
+```
+
 
 ## Rationale