Skip to content

Commit

Permalink
- update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mrVragec committed May 7, 2017
1 parent 9504022 commit cc75d48
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
@@ -1,8 +1,15 @@
# MMM-uptimerobot [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mrVragec/MMM-uptimerobot/raw/master/LICENSE) [![Build Status](https://api.travis-ci.org/mrVragec/MMM-uptimerobot.svg?branch=master)](https://travis-ci.org/mrVragec/MMM-uptimerobot) [![Known Vulnerabiliries](https://snyk.io/test/github/mrvragec/mmm-uptimerobot/badge.svg)](https://snyk.io/test/github/mrvragec/mmm-uptimerobot) [![Code Climate](https://codeclimate.com/github/mrVragec/MMM-uptimerobot/badges/gpa.svg)](https://codeclimate.com/github/mrVragec/MMM-uptimerobot)

This is a module for the [MagicMirror²](https://github.com/MichMich/MagicMirror/).
MagicMirror² to get uptime data from http://uptimerobot.com API.

Todo: Insert description here!
## Examples
![](.github/text.png) ![](.github/text_color.png) ![](.github/icons.png) ![](.github/icons_color.png)


## Instalation
1. Clone this repository in your MagicMirror installation under modules.
2. Rename plugin foler from 'MMM-uptimerobot' to 'uptimerobot'
3. Add configuration to config.js

## Using the module

Expand All @@ -11,17 +18,17 @@ To use this module, add the following configuration block to the modules array i
var config = {
modules: [
{
module: 'MMM-uptimerobot',
module: 'uptimerobot',
config: {
// See below for configurable options
}
}
]
}
```

## Requirements

No special requirements or dependencies.

## Configuration options

Expand Down

0 comments on commit cc75d48

Please sign in to comment.