Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.83 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.83 KB
Raw

MMM-Chuck-Norris

MMM-Chuck-Norris is a module for the MagicMirror².

Description

Magic Mirror Module that displays Chuck Norris Facts from the free public API Chuck Norris API that requires no API key. This project is my first module based on the MagicMirror Template and my project is completed.

Installation

To install this module simply clone git clone https://github.com/toddsantoro/MMM-Chuck-Norris.git this repository into your modules folder and run npm install inside of MMM-Chuck-Norris. Make sure to have Grunt installed npm install -g grunt-cli and you may have to use sudo npm install -g grunt-cli. Once that has completed run grunt inside of MMM-Chuck-Norris folder. Then add the config below to your MagicMirror/config/config.js file by entering this in the terminal nano ~/MagicMirror/config/config.js. Then run npm start in the MagicMirror folder and you will start to see Chuck Norris Facts every 20 seconds (default). To update from the module's folder simply enter git pull origin master and restart MagicMirror.

TODO: add a config variable to change the time between new facts.

Using the module

requiresVersionOfMagicMirror: "2.1.0"

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
            module: "MMM-Chuck-Norris",
            position: "bottom_bar",
            header: "Chuck Norris Facts"
        }
    ]
}

Configuration options

Option Description
header Can be changed to any string or left blank: ' '

alt text