add old readme

README.md

@@ -1,44 +1,56 @@
-# Grafana Panel Plugin Template
+# Grafana Chartwerk Panel (beta)
-
+
-[![Build](https://github.com/grafana/grafana-starter-panel/workflows/CI/badge.svg)](https://github.com/grafana/grafana-starter-panel/actions?query=workflow%3A%22CI%22)
+<p align="center"><img src="https://user-images.githubusercontent.com/66464000/84520316-6c6fab00-ace4-11ea-9bfc-29ca73e5105e.png" width="150" height="150" /></div>
-
+
-This template is a starting point for building Grafana Panel Plugins in Grafana 7.0+
+[![Build Status](https://travis-ci.org/chartwerk/grafana-chartwerk-app.svg?branch=master)](https://travis-ci.org/chartwerk/grafana-chartwerk-app)
-
+
-## What is Grafana Panel Plugin?
+ **Grafana Chartwerk Panel** renders metrics using ChartWerk libraries. For now, it can render as a line and a series of bars. We are working on adding new visualizations.
-
+
-Panels are the building blocks of Grafana. They allow you to visualize data in different ways. While Grafana has several types of panels already built-in, you can also build your own panel, to add support for other visualizations.
+![image](https://user-images.githubusercontent.com/66464000/84491085-10416280-acb5-11ea-8af0-2761ed97aecc.png)
-
+![image](https://user-images.githubusercontent.com/66464000/84491069-0b7cae80-acb5-11ea-959b-ef67835c8055.png)
-For more information about panels, refer to the documentation on [Panels](https://grafana.com/docs/grafana/latest/features/panels/panels/)
+
-
+## Features
-## Getting started
+
-
+- 2 types of visualizations:
-1. Install dependencies
+  - line-chart
-
+  - bar-chart
-   ```bash
+- ability to make panel's time range independent of dashboard's (doesn't work in Grafana 7).
-   yarn install
+- ability to display template variables inside the panel.
-   ```
+- "Charge" mode: green color for positive graph's slope, red color for negative graph's slope.
-
+- confidence interval (for line).
-2. Build plugin in development mode or run in watch mode
+- customizable X-axis labels.
-
+- customizable grid interval.
-   ```bash
+
-   yarn dev
+## Installation
-   ```
+### Linux / Mac OS X
-
+- Navigate to either: 
-   or
+  - `<GRAFANA_PATH>/data/plugins` (when installed from tarball or source) 
-
+  - or `/var/lib/grafana/plugins` (when installed from `.deb`/`.rpm` package)
-   ```bash
+
-   yarn watch
+- Download ChartWerk panel
-   ```
+```
-
+wget https://github.com/chartwerk/grafana-chartwerk-app/archive/0.3.3.zip
-3. Build plugin in production mode
+```
-
+
-   ```bash
+- Unpack downloaded files
-   yarn build
+```
-   ```
+unzip 0.3.3.zip
-
+```
-## Learn more
+
-
+- Restart grafana-server
-- [Build a panel plugin tutorial](https://grafana.com/tutorials/build-a-panel-plugin)
+  - For grafana installed via Standalone Linux Binaries:
-- [Grafana documentation](https://grafana.com/docs/)
+    - Stop any running instances of grafana-server
-- [Grafana Tutorials](https://grafana.com/tutorials/) - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
+    - Start grafana-server by:
-- [Grafana UI Library](https://developers.grafana.com/ui) - UI components to help you build interfaces using Grafana Design System
+      ```$GRAFANA_PATH/bin/grafana-server```
+  - For grafana installed via Package Manager:
+    - type in ```systemctl restart grafana-server```
+
+### Grafana in Docker
+You can install ChartWerk panel to Grafana in Docker passing it as environment variable (as described in [Grafana docs](http://docs.grafana.org/installation/docker/#installing-plugins-from-other-sources))
+
+```bash
+docker run \
+  -p 3000:3000 \
+  -e "GF_INSTALL_PLUGINS=https://github.com/chartwerk/grafana-chartwerk-app/archive/0.3.3.zip;corpglory-chartwerk-panel" \
+  grafana/grafana
+```