upd docs

README.md

@@ -25,10 +25,6 @@
 - Choose visualization type
 - Select metric in the Value -> Metric dropdown (by default, the first metric is used)
 
-## Demo
-
-see [demo](https://grafana.corpglory.com/d/8vGyMypGz/demo-home?orgId=4)
-
 ## Options [Gauge]
 
 - Visualization:
@@ -84,3 +80,7 @@ docker run \
   -e "GF_INSTALL_PLUGINS=https://code.corpglory.net/attachments/d4257ab5-65f0-4c87-8b89-3803b26d504f;corpglory-chartwerk-panel" \
   grafana/grafana
 ```
+
+## Demo
+
+see [demo](https://grafana.corpglory.com/d/8vGyMypGz/demo-home?orgId=4)

src/README.md

@@ -0,0 +1,46 @@
+# Grafana Chartwerk Panel (beta)
+
+<p align="center"><img src="https://code.corpglory.net/chartwerk/grafana-chartwerk-panel/raw/branch/main/src/assets/logo.svg" width="150" height="150" /></div>
+
+**Grafana Chartwerk Panel** renders metrics using Chartwerk libraries. For now, it can render as Gauge. We are working on adding new visualizations.
+
+![image](https://code.corpglory.net/chartwerk/grafana-chartwerk-panel/raw/branch/main/src/assets/img/gauge.png)
+
+## Features
+
+- 3 types of visualizations:
+  - Gauge
+  - Line Chart (coming soon)
+  - 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 queries with unique aliases
+3. Go to the Options Tab and setup panel:
+
+- Choose visualization type
+- Select metric in the Value -> Metric dropdown (by default, the first metric is used)
+
+## 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
+
+## Demo
+
+see [demo](https://grafana.corpglory.com/d/8vGyMypGz/demo-home?orgId=4)