From e221551ac99ec15ab4d3b00b7c285bd69135a906 Mon Sep 17 00:00:00 2001
From: vargburz <vargburz@corpglory.com>
Date: Fri, 8 Jul 2022 17:00:47 +0300
Subject: [PATCH] update docs

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 15f32be..a0b760a 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,35 @@
   - Bar Chart (coming soon)
 - Gauge: dynamic thresholds and min / max
 - Gauge: conditional icons displaying
-
+- Gauge: reversed direction
+
+## How to use
+
+1. Create a new panel and select Chartwerk as the visualization
+2. Add multiple queries with a unique alias
+3. Go to the Options Tab and setup panel:
+  - Choose visualization type (Gauge is the only available option for now)
+  - Select metric in the Value -> Metric dropdown (the first query metric will be used as a default one)
+
+## Demo
+
+see [demo](https://grafana.corpglory.com/d/8vGyMypGz/demo-home?orgId=4)
+
+## Options [Gauge]
+
+- Visualization:
+  - Pod: option to select chart type
+- Value:
+  - Metric: select metric query from dropdown
+- Extemum:
+  - Min: 
+    - type number for static minimum value OR 
+    - enable "Use metric" toggle switch to select metric as minimun
+    - default value: 0 
+  - Max:
+    - type number for static maximum OR 
+    - enable "Use metric" toggle switch to select metric as maximum
+    - default value: maximum of metric query
 ## Installation
 
 ### Linux / Mac OS X