updated readme

Author: speakyourcode

README.md

@@ -1,81 +1,35 @@
-# Grafana panel plugin template
+# Grafana Button Control Panel
 
-This template is a starting point for building a panel plugin for Grafana.
+This panel allows you to create buttons and define actions for them. It can be
+used to add control functionality to your dashboards. Actions are defined as
+queries to Datasources.
 
-## What are Grafana panel plugins?
+Multiple buttons are allowed within a single panel, they can be arranged either
+horizontally or vertically.
 
-Panel plugins allow you to add new types of visualizations to your dashboard, such as maps, clocks, pie charts, lists, and more.
+The query field is a JSON object, that depends on each Datasource type. You can
+use Grafana's Query Inspector to find out what Grafana sends to each Datasource,
+and copy those into the query field.
 
-Use panel plugins when you want to do things like visualize data returned by data source queries, navigate between dashboards, or control external systems (such as smart home devices).
+## Examples
 
-## Getting started
+Query field to delete InfluxDB database:
 
-### Frontend
+```json
+{
+  "query": "drop database \"foo\"",
+  "rawQuery": true,
+  "resultFormat": "time_series"
+}
+```
 
-1. Install dependencies
+Same example with PostgreSQL:
 
-   ```bash
-   yarn install
-   ```
+```json
+{
+  "rawSql": "DROP DATABASE foo;",
+  "format": "table"
+}
+```
 
-2. Build plugin in development mode or run in watch mode
-
-   ```bash
-   yarn dev
-
-   # or
-
-   yarn watch
-   ```
-
-3. Build plugin in production mode
-
-   ```bash
-   yarn build
-   ```
-
-4. Run the tests (using Jest)
-
-   ```bash
-   # Runs the tests and watches for changes
-   yarn test
-   
-   # Exists after running all the tests
-   yarn lint:ci
-   ```
-
-5. Spin up a Grafana instance and run the plugin inside it (using Docker)
-
-   ```bash
-   yarn server
-   ```
-
-6. Run the E2E tests (using Cypress)
-
-   ```bash
-   # Spin up a Grafana instance first that we tests against 
-   yarn server
-   
-   # Start the tests
-   yarn e2e
-   ```
-
-7. Run the linter
-
-   ```bash
-   yarn lint
-   
-   # or
-
-   yarn lint:fix
-   ```
-
-
-
-## Learn more
-
-Below you can find source code for existing app plugins and other related documentation.
-
-- [Basic panel plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/panel-basic#readme)
-- [Plugin.json documentation](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/)
-- [How to sign a plugin?](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/)
+`refId`, `datasourceId` are automatically sent, so you don't have to set them.