update

.travis.yml

@@ -26,6 +26,7 @@ before_script:
 - yarn install
 - curl -sLo consul.zip https://releases.hashicorp.com/consul/${CONSUL_VERSION}/consul_${CONSUL_VERSION}_linux_amd64.zip
 - unzip consul.zip
+- rm -rf consul.zip
 - mkdir -p ~/bin
 - mv consul ~/bin
 - export PATH="~/bin:$PATH"
@@ -47,6 +48,10 @@ before_deploy:
 - rm -rf ./consul-datasource-${TRAVIS_TAG}/.git
 - rm -rf ./consul-datasource-${TRAVIS_TAG}/.idea
 - rm -rf ./consul-datasource-${TRAVIS_TAG}/*.iml
+- rm -rf ./consul-datasource-${TRAVIS_TAG}/coverage
+- rm -rf ./consul-datasource-${TRAVIS_TAG}/example
+- rm -rf ./consul-datasource-${TRAVIS_TAG}/spec
+- rm -rf ./consul-datasource-${TRAVIS_TAG}/test
 - zip -r consul-datasource-${TRAVIS_TAG}.zip consul-datasource-${TRAVIS_TAG}
 
 

README.md

@@ -7,7 +7,7 @@
 
 This datasource lets you integrate key value data from Consul in Grafana dashboards.
 
-![Overview](https://github.com/sbueringer/consul-datasource/docs/overview.png)
+![Overview](https://github.com/sbueringer/consul-datasource/raw/master/docs/overview.png)
 
 # Usage
 
@@ -22,14 +22,29 @@ The data can be used in **table** and **single-stat** panels. The following expl
 5. Fill in the datasource name, the Consul address and the Consul token
 6. Click the `Save & Test` button
 
-## Panels
+## Features
 
-### Single Stat Panel
+* Consul keys can be used as Dashboard variable values
+* Numeric Consul keys can be retrieved directly and displayed in Singlestat panels
+* Consul key/value pairs can be retrieved via Timeseries tags and displayed in Singlestat panels
+* Consul key/value pairs can be displayed in Table panels.
 
-TODO all 4 types... (if possible)
+## Examples
 
-### Table Panel
+### Variables
+
+![Variables](https://github.com/sbueringer/consul-datasource/raw/master/docs/keys.png)
+
+This example shows how keys can be queried to use them as variables. This query retrieves all direct subkeys of `registry/apiregistration.k8s.io/apiservices/`. The subkeys are then matched via the regex and can then be used as variable values.
+
+### Singlestat Panel
 
-TODO
+![Tags](https://github.com/sbueringer/consul-datasource/raw/master/docs/tags.png)
+
+This example shows how subkeys can be retrieved as tags. These tags can then be displayed in the Single Stat panel by defining a legend format. *Note*: This only works if `Value / Stat` in the `Option` tab is set to `Name`.
+
+### Table Panel
 
+![Table](https://github.com/sbueringer/consul-datasource/raw/master/docs/table.png)
 
+The final examples shows how key/value pairs can be displayed in tables. Every matching key of the query results in one row. Columns can then be retrieved relative from this key. 

dist/README.md

@@ -7,7 +7,7 @@
 
 This datasource lets you integrate key value data from Consul in Grafana dashboards.
 
-![Overview](https://github.com/sbueringer/consul-datasource/docs/overview.png)
+![Overview](https://github.com/sbueringer/consul-datasource/raw/master/docs/overview.png)
 
 # Usage
 
@@ -22,14 +22,29 @@ The data can be used in **table** and **single-stat** panels. The following expl
 5. Fill in the datasource name, the Consul address and the Consul token
 6. Click the `Save & Test` button
 
-## Panels
+## Features
 
-### Single Stat Panel
+* Consul keys can be used as Dashboard variable values
+* Numeric Consul keys can be retrieved directly and displayed in Singlestat panels
+* Consul key/value pairs can be retrieved via Timeseries tags and displayed in Singlestat panels
+* Consul key/value pairs can be displayed in Table panels.
 
-TODO all 4 types... (if possible)
+## Examples
 
-### Table Panel
+### Variables
+
+![Variables](https://github.com/sbueringer/consul-datasource/raw/master/docs/keys.png)
+
+This example shows how keys can be queried to use them as variables. This query retrieves all direct subkeys of `registry/apiregistration.k8s.io/apiservices/`. The subkeys are then matched via the regex and can then be used as variable values.
+
+### Singlestat Panel
 
-TODO
+![Tags](https://github.com/sbueringer/consul-datasource/raw/master/docs/tags.png)
+
+This example shows how subkeys can be retrieved as tags. These tags can then be displayed in the Single Stat panel by defining a legend format. *Note*: This only works if `Value / Stat` in the `Option` tab is set to `Name`.
+
+### Table Panel
 
+![Table](https://github.com/sbueringer/consul-datasource/raw/master/docs/table.png)
 
+The final examples shows how key/value pairs can be displayed in tables. Every matching key of the query results in one row. Columns can then be retrieved relative from this key.