Skip to content

Commit

Permalink
included example picture
Browse files Browse the repository at this point in the history
  • Loading branch information
SvenSommer committed Jul 7, 2017
1 parent 46275ec commit 862c823
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Magic Mirror Module: MMM-GrafanaChart
This [MagicMirror²](https://github.com/MichMich/MagicMirror) module allows you to display a chart generated by [grafana](https://grafana.com/).

<b>Important Note:</b> This module requires a running grafana installation. To install Grafana, follow the original [installation instructions](http://docs.grafana.org/installation/).
<b>Important Note:</b> This module requires a running grafana installation. To install Grafana, follow the official [installation instructions](http://docs.grafana.org/installation/).

[This blogpost]() describes how to install and use grafana for displaying a weatherchart like the one below.
[This blogpost]() describes how to install and use grafana to display a weatherchart.
Example:
![example of a grafana weather chart](https://github.com/SvenSommer/MMM-GrafanaChart/blob/master/weather_explained.gif?raw=true)

## Installation of the module

Expand All @@ -22,9 +24,7 @@ Configure the module in your `config.js` file.
## Configuration

To use this module, you have to specify where your grafana installation is hosted and which chart you'd like to display.
Everything you need is in the url when you're viewing your chart in your browser

![url provides needed information](https://github.com/SvenSommer/MMM-GrafanaChart/blob/master/config_url.png?raw=true)


Add the module to the modules array in the `config/config.js` file:
Expand All @@ -48,6 +48,9 @@ modules: [
]
````

Everything needed is extractable from the <code>url</code> when you're viewing your chart using grafana in your browser.

![url provides needed information](https://github.com/SvenSommer/MMM-GrafanaChart/blob/master/config_url.png?raw=true)
## Optional configuration options

The following properties can be configured:
Expand Down
Binary file added weather_explained.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 862c823

Please sign in to comment.