Merge branch 'docs-update' into 'main'

Docs update

See merge request chartwerk/grafana-chartwerk-panel!11

README.md

@@ -14,6 +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 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)
+
+## 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
 

src/plugin.json

@@ -4,7 +4,7 @@
   "name": "Chartwerk",
   "id": "corpglory-chartwerk-panel",
   "info": {
-    "description": "",
+    "description": "Chartwerk panel with extended chart customization",
     "author": {
       "name": "CorpGlory Inc.",
       "url": "https://corpglory.com"
@@ -17,11 +17,15 @@
     "links": [
       {
         "name": "Website",
-        "url": "https://gitlab.com/chartwerk/grafana-chartwerk-panel"
+        "url": "https://chartwerk.io/"
       },
       {
         "name": "License",
         "url": "https://gitlab.com/chartwerk/grafana-chartwerk-panel/blob/main/LICENSE"
+      },
+      {
+        "name": "Gitlab",
+        "url": "https://gitlab.com/chartwerk/grafana-chartwerk-panel/"
       }
     ],
     "screenshots": [
@@ -34,7 +38,7 @@
     "updated": "%TODAY%"
   },
   "dependencies": {
-    "grafanaDependency": ">=8.0.0",
+    "grafanaDependency": ">=8.3.0",
     "plugins": []
   }
 }