added preview pictures and documented global config option

fewieden · Jan 25, 2021 · 90a8dfa · 90a8dfa
1 parent 3ae3ed9
commit 90a8dfa
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 0 deletions.
diff --git a/.github/example_nhl.png b/.github/example_nhl.png
diff --git a/.github/example_nhl_2.png b/.github/example_nhl_2.png
diff --git a/.github/example_nhl_3.png b/.github/example_nhl_3.png
diff --git a/.github/global.png b/.github/global.png
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 National Hockey League Module for MagicMirror<sup>2</sup>
 
+## Examples
+
+![](.github/example_nhl.png) ![](.github/example_nhl_2.png) ![](.github/example_nhl_3.png)
+
 ## Dependencies
 
 * An installation of [MagicMirror<sup>2</sup>](https://github.com/MichMich/MagicMirror)
@@ -40,6 +44,16 @@ National Hockey League Module for MagicMirror<sup>2</sup>
 | `showNames` | `true` | Should team names be displayed? |
 | `showLogos` | `true` | Should team logos be displayed? |
 
+## Global config
+
+| **Option** | **Default** | **Description** |
+| --- | --- | --- |
+| `locale` | `undefined` | By default it is using your system settings. You can specify the locale in the global MagicMirror config. Possible values are for e.g.: `'en-US'` or `'de-DE'`. |
+
+To set a global config you have top set the value in your config.js file inside the MagicMirror project.
+
+![](.github/global.png)
+
 ## Developer
 
 * `npm run lint` - Lints JS and CSS files.