From ff3e18d63f29e66ca7b899492ae26086645bd258 Mon Sep 17 00:00:00 2001 From: Simon Crnko Date: Wed, 3 Jan 2018 19:13:06 +0100 Subject: [PATCH] - update example in README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 28a00f7..9f5d585 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MMM-mvgmunich [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mrVragec/MMM-mvgmunich/raw/master/LICENSE) [![Build Status](https://api.travis-ci.org/mrVragec/MMM-mvgmunich.svg?branch=master)](https://travis-ci.org/mrVragec/MMM-mvgmunich) [![Known Vulnerabiliries](https://snyk.io/test/github/mrvragec/mmm-mvgmunich/badge.svg)](https://snyk.io/test/github/mrvragec/mmm-mvgmunich) [![Code Climate](https://codeclimate.com/github/mrVragec/MMM-mvgmunich/badges/gpa.svg)](https://codeclimate.com/github/mrVragec/MMM-mvgmunich) -MagicMirror² Module to monitor public transport (U-bahn, tram, bus, S-Bahn) in Munich - Germany. +MagicMirror² Module to monitor public transport (U-bahn, tram, bus, S-Bahn) in Munich - Germany. ## Example ![](.github/Example_1.png) ![](.github/Example_2.png) @@ -12,7 +12,7 @@ MagicMirror² Module to monitor public transport (U-bahn, tram, bus, S-Bahn) in ## Installation 1. Clone this repository in your MagicMirror installation under modules. 2. Rename plugin foler from 'MMM-mvgmunich' to 'mvgmunich' -3. Install dependencies in main MagicMirror folder +3. Install dependencies in main MagicMirror folder 4. Add configuration block to your config.js: ``` { @@ -21,15 +21,15 @@ MagicMirror² Module to monitor public transport (U-bahn, tram, bus, S-Bahn) in header: "MVG", config: { haltestelle: "Hauptbahnhof", - maxEntries: 25, // 10 items on screen - updateInterval: 60000, // 60 s - showUbahn: true, //show ubahn route - showBus: true, // show bus route - showTram: true, // show tram route - showSbahn: true // show sbahn route - ignoreStations: [] // destination not to be shown - timeToWalk: 10 // 10 min walking time to station. Default is 0 - includeWalkingTime: false // if the walking time should be included and the starting time is displayed + maxEntries: 25, // 10 items on screen + updateInterval: 60000, // 60 s + showUbahn: true, // show ubahn route + showBus: true, // show bus route + showTram: true, // show tram route + showSbahn: true, // show sbahn route + ignoreStations: [], // destination not to be shown + timeToWalk: 10, // 10 min walking time to station. Default is 0 + includeWalkingTime: false // if the walking time should be included and the starting time is displayed } }, ``` @@ -46,4 +46,4 @@ MagicMirror² Module to monitor public transport (U-bahn, tram, bus, S-Bahn) in | `showSbahn` |Show data for S-Bahn.
**Possible values:** `true` or `false`
**Default:** `true` | | `ignoreStations` |Ignore destinations based on a array list.
**Possible values e.g.:** `["Feldmoching", "Hauptbahnhof"]`
**Default** `[]` | | `timeToWalk` | Time to walk to the station from your current location
**Default:** `0` minutes | -| `includeWalkingTime` | If the time to leave should be displayed which includes the walking time.
**Default:** `false` | \ No newline at end of file +| `includeWalkingTime` | If the time to leave should be displayed which includes the walking time.
**Default:** `false` |