Skip to content

Commit 7ffa589

Browse files
committed
update README.md
1 parent a15dbbb commit 7ffa589

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

.editorconfig

+3
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ indent_style = space
1111
indent_size = 2
1212
charset = utf-8
1313
trim_trailing_whitespace = true
14+
15+
[*.md]
16+
trim_trailing_whitespace = false

README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# MMM-covid19
2-
Magic Mirror Module to display stats on Covid19.
2+
Magic Mirror Module to display stats on Covid19.
33
Data is provided by _https://covid19api.com/_
44

55
The data shown in the table displays the total numbers (top) and the difference calculated on the last 24 hours of available data. Reference timezone is UTC.
66

7+
## installation
8+
This 3rd party module install just like any other.
9+
This Magic Mirror Forum thread describe a step-by-step procedure to install: [How to add modules. For absolute beginners.](https://forum.magicmirror.builders/topic/4231/how-to-add-modules-for-absolute-beginners?_=1622723520331)
10+
11+
Check the configuration documentation below to ensure all set-up is done correctly.
12+
13+
714
## configuration
815
the default configuration looks like this:
916
```js
@@ -22,25 +29,25 @@ the default configuration looks like this:
2229
}
2330
```
2431

25-
- `countryCodes`: an Array of ISO2 values.
32+
- `countryCodes`: an Array of ISO2 values.
2633
A list cen be obtain at this url: https://api.covid19api.com/countries
2734

28-
- `world`: a boolean value (`true` or `false`).
35+
- `world`: a boolean value (`true` or `false`).
2936
Set to `true`it shows the world total numbers, it does not otherwise.
3037

31-
- `live`: a boolean value (`true` or `false`).
32-
Set to `true`it shows the total numbers per country set in `countryCodes`, it does not otherwise.
38+
- `live`: a boolean value (`true` or `false`).
39+
Set to `true` it shows the total numbers per country set in `countryCodes`, it does not otherwise.
3340

34-
- `updateInterval`: a number in milliseconds to be used to refresh the numbers. Its value is only used when `useScheduler=false`.
41+
- `updateInterval`: a number in milliseconds to be used to refresh the numbers. Its value is only used when `useScheduler=false`.
3542
Its default values invokes an API call every 24 hours from starting from the first one.
3643

37-
- `useScheduler`: a boolean value (`true` or `false`).
44+
- `useScheduler`: a boolean value (`true` or `false`).
3845
Set to `true` it uses _cron_ like approach to refresh the data. It uses [`node-schedule`](https://github.com/node-schedule/node-schedule), in order to be able to use thi option, you need to run `npm install`
3946

40-
- `schedulerConfig`: a valid `node-schedule`configuration as a string or as an object.
47+
- `schedulerConfig`: a valid `node-schedule`configuration as a string or as an object.
4148
Its default value execute an API call _twice a day every day ad 12am and 12pm UTC time_.
42-
43-
49+
50+
4451
The numbers shown are the delta between last day 00:00 UTC and the day before 00:00 UTC. The dates can be shown at the bottom of the list.
4552

4653
## screenshots

0 commit comments

Comments
 (0)