fewieden/MMM-ScottishPremierLeague

# MMM-ScottishPremierLeague [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/fewieden/MMM-ScottishPremierLeague/master/LICENSE) [![Build Status](https://travis-ci.org/fewieden/MMM-ScottishPremierLeague.svg?branch=master)](https://travis-ci.org/fewieden/MMM-ScottishPremierLeague) [![Code Climate](https://codeclimate.com/github/fewieden/MMM-ScottishPremierLeague/badges/gpa.svg?style=flat)](https://codeclimate.com/github/fewieden/MMM-ScottishPremierLeague) [![Known Vulnerabilities](https://snyk.io/test/github/fewieden/mmm-scottishpremierleague/badge.svg)](https://snyk.io/test/github/fewieden/mmm-scottishpremierleague)

Scottish Premier League Standings Module for MagicMirror<sup>2</sup>

## Example

![](.github/example.jpg)

## Dependencies

* An installation of [MagicMirror<sup>2</sup>](https://github.com/MichMich/MagicMirror)
* npm
* [request](https://www.npmjs.com/package/request)
* [xml2js](https://www.npmjs.com/package/xml2js)

## Installation

1. Clone this repo into `~/MagicMirror/modules` directory.
1. Configure your `~/MagicMirror/config/config.js`:

    ```
    {
        module: 'MMM-ScottishPremierLeague',
        position: 'bottom_right',
        config: {
            api_key: 'ABC34689KLKDEGFO906SGFLSGFNM4EMP',
            ...
        }
    }
    ```

1. Run command `npm install --productive` in `~/MagicMirror/modules/MMM-ScottishPremierLeague` directory.

## Config Options

| **Option** | **Default** | **Description** |
| --- | --- | --- |
| `api_key` | REQUIRED | Get a free api key for the Scottish Premier League [here](http://www.xmlsoccer.com/Register.aspx). |
| `season` | `'1617'` | Which season should be displayed. |
| `focus_on` | `false` | Which team should the standings focus on e.g. "Rangers", "TOP" or "BOTTOM". Omit this option or set to false to show the full league table. |
| `max_teams` | `false` | How many teams should be displayed. Omit this option or set to false to show the full league table. |
| `updateInterval` | `10800000` (3 hours) | How often should the data be fetched |