Skip to content

Commit 236ddac

Browse files
committed
Adjusted language support description
1 parent 368c138 commit 236ddac

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -83,31 +83,24 @@ let config = {
8383

8484
All options are optional so the module works out of the box.
8585

86-
| Option | Description |
87-
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
88-
| `language` | Events language. If the language is set to `null` (default), the global Mirror language ist used.<br><br>**Type:** `String`<br>**Default:** `null` |
89-
| `animationSpeed` | Duration of content refresh animation in seconds.<br><br>**Type:** `Number`<br>**Default:** `1` |
90-
| `updateInterval` | Time between loading new events data in seconds.<br><br>**Type:** `Number`<br>**Default:** `3600` (1 hour) |
91-
| `carousel` | Show events in carousel mode (one event at a time).<br><br>**Type:** `Boolean`<br>**Default:** `false` |
92-
| `carouselInterval` | Time between events in carousel mode in seconds. Use `auto` for word count based intervals.<br><br>**Type:** `Number` or `String`<br>**Default:** `30` (30 seconds) |
93-
| `carouselIntervalWordFactor` | Used to calculate the event display duration when using `carouselInterval: 'auto'`.<br><br>**Type:** `Number`<br>**Default:** `1` (1 second |
94-
| `carouselProgress` | Display a progress indicator for carousel intervals.<br><br>**Type:** `Boolean`<br>**Default:** `false` |
95-
| `maxEvents` | Display up to the given number of events if supported.<br><br>**Type:** `Number`<br>**Default:** `null` |
96-
| `reverseOrder` | Display events in reversed order if supported.<br><br>**Type:** `Boolean`<br>**Default:** `false` |
97-
| `maxWidth` | Max width of the displayed events content.<br><br>**Type:** `String`<br>**Default:** `400px` |
98-
| `textSize` | CSS class to set the text size, use MagicMirror core classes here<br><br>**Type:** `String`<br>**Default:** `xsmall` |
86+
| Option | Description |
87+
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
88+
| `language` | Events language. If the language is set to `null` (default), the global Mirror language ist used. See [Language](#language).<br><br>**Type:** `String`<br>**Default:** `null` |
89+
| `animationSpeed` | Duration of content refresh animation in seconds.<br><br>**Type:** `Number`<br>**Default:** `1` |
90+
| `updateInterval` | Time between loading new events data in seconds.<br><br>**Type:** `Number`<br>**Default:** `3600` (1 hour) |
91+
| `carousel` | Show events in carousel mode (one event at a time).<br><br>**Type:** `Boolean`<br>**Default:** `false` |
92+
| `carouselInterval` | Time between events in carousel mode in seconds. Use `auto` for word count based intervals.<br><br>**Type:** `Number` or `String`<br>**Default:** `30` (30 seconds) |
93+
| `carouselIntervalWordFactor` | Used to calculate the event display duration when using `carouselInterval: 'auto'`.<br><br>**Type:** `Number`<br>**Default:** `1` (1 second |
94+
| `carouselProgress` | Display a progress indicator for carousel intervals.<br><br>**Type:** `Boolean`<br>**Default:** `false` |
95+
| `maxEvents` | Display up to the given number of events if supported.<br><br>**Type:** `Number`<br>**Default:** `null` |
96+
| `reverseOrder` | Display events in reversed order if supported.<br><br>**Type:** `Boolean`<br>**Default:** `false` |
97+
| `maxWidth` | Max width of the displayed events content.<br><br>**Type:** `String`<br>**Default:** `400px` |
98+
| `textSize` | CSS class to set the text size, use MagicMirror core classes here<br><br>**Type:** `String`<br>**Default:** `xsmall` |
9999

100100
## Language
101101

102-
The global configured language for MagicMirror is used by this module. English will be the fallback, if it doesn't support the used language.
103-
104-
Currently supported languages:
105-
106-
- Arabic
107-
- English
108-
- French
109-
- German
110-
- Russian
102+
The global configured language of your MagicMirror is used by default in this module. Use the `language` config option to
103+
change it. See the Wikimedia Feed API reference for [supported languages](https://api.wikimedia.org/wiki/Feed_API/Language_support#Daily_featured_article).
111104

112105
## Problems
113106

0 commit comments

Comments
 (0)