diff --git a/modules/calendar/README.md b/modules/calendar/README.md new file mode 100644 index 00000000..6cf766bf --- /dev/null +++ b/modules/calendar/README.md @@ -0,0 +1,142 @@ +# Module: Calendar +The `calendar` module is one of the default modules of the MagicMirror. +This module displays events from a public .ical calendar. It can combine multiple calendars. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'calendar', + position: 'top_left', // This can be any of the regions. Best results in left or right regions. + config: { + // The config property is optional. + // If no config is set, an example calendar is shown. + // See 'Configuration options' for more information. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
maximumEntriesThe maximum number of events shown.
+
Possible values: 0 - 100 +
Default value: 10 +
displaySymbolDisplay a symbol in front of an entry.
+
Possible values: true or false +
Default value: true +
defaultSymbolThe default symbol.
+
Possible values: See Font Awsome website. +
Default value: calendar +
maxTitleLengthThe maximum title length.
+
Possible values: 10 - 50 +
Default value: 25 +
fetchIntervalHow often does the content needs to be fetched? (Milliseconds)
+
Possible values: 1000 - 86400000 +
Default value: 30000 (5 minutes) +
animationSpeedSpeed of the update animation. (Milliseconds)
+
Possible values:0 - 5000 +
Default value: 2000 (2 seconds) +
fadeFade the future events to black. (Gradient)
+
Possible values: true or false +
Default value: true +
fadePointWhere to start fade?
+
Possible values: 0 (top of the list) - 1 (bottom of list) +
Default value: 0.25 +
calendarsThe list of calendars.
+
Possible values: An array, see calendar configuration below. +
Default value: An example calendar. +
+ +### Calendar configuration + +The `calendar` property contains an array of the configured calendars. + +#### Default value: +````javascript +config: { + calendars: [ + { + url: 'http://www.calendarlabs.com/templates/ical/US-Holidays.ics', + symbol: 'calendar', + }, + ], +} +```` + + +#### Calendar configuration options: + + + + + + + + + + + + + + + + + + +
OptionDescription
urlThe url of the calendar .ical. This property is required.
+
Possible values: Any public accessble .ical calendar. +
symbol The symbol to show in front of an event. This property is optional.
+
Possible values: See Font Awsome website. +
\ No newline at end of file diff --git a/modules/clock/README.md b/modules/clock/README.md new file mode 100644 index 00000000..035660f4 --- /dev/null +++ b/modules/clock/README.md @@ -0,0 +1,49 @@ +# Module: Clock +The `clock` module is one of the default modules of the MagicMirror. +This module displays the current date and time. The information will be updated realtime. + +## Using the module + +To use this module, add it to the modules array in the `config/config.js` file: +````javascript +modules: [ + { + module: 'clock', + position: 'top_left', // This can be any of the regions. + config: { + // The config property is optional. + // See 'Configuration options' for more information. + } + } +] +```` + +## Configuration options + +The following properties can be configured: + + + + + + + + + + + + + + + + + + + +
OptionDescription
timeFormatUse 12 of 24 hour format.
+
Possible values: +
Default value: +
displaySecondsDisplay seconds.
+
Possible values: true or false +
Default value: true +