Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.32 KB

README.md

File metadata and controls

44 lines (32 loc) · 1.32 KB
Raw

MMM-DogBrew GitHub license

Simple module for MagicMirror2 that utilizes the api.catalog.beer to fetch a random beer

API: https://api.punkapi.com/v2/beers/random (no key needed)

Example

Dependencies

  • An installation of MagicMirror2
  • No other dependencies required
  • api.catalog.beer api key

Installation

  1. Clone this repo: git clone https://github.com/phpwun/MMM-Dogbrew/tree/master into ~/MagicMirror/modules directory.
  2. Create an account at https://catalog.beer/signup and get an API Key
  3. Configure your ~/MagicMirror/config/config.js:
  4. Ensure your API Key is added to both the Config and the Brewdog.js file
{
    module: 'Brewdog',
    position: 'top_left',
    config: {
        useheader: true,
        header: "Here's a new beer!",
        updateInterval: 60000,
        apiKey: "APIKEYHERE"
    }
},

Config Options

Option Default Description
useHeader true Boolean for header visibility
header 'Brewdog Beers' Change to whatever you want
updateInterval 60000 How often until we get another beer