search

bibaldo / MMM-CountUP

Just a simple progressive counter from a specific date
MIT License
4 stars 2 forks source link

readme

MMM-CountUP

A MagicMirror² helper module to create a progressive counter from a specific date.

license

Example

Installation

In your terminal, go to your MagicMirror's Module folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/bibaldo/MMM-CountUP.git

Add the module to the modules array in the config/config.js file:

  {
    module: "MMM-CountUP"
  },

Configuration options

The following properties can be configured:

Option Description
header The header text

Default value: 'Days passed since COVID19 Quarantine'
date Start date
Format: YYYY-MM-DD
time Start time
Format: HH:MM:SS
showFullDate Show or not a full date with years, months, weeeks, etc

Default value: false
showOnlyWeeks Show or not date with weeeks and days only

Default value: false

Config Example

  {
    module: "MMM-CountUP",
    config: {
      header: 'Days passed since COVID19 Quarantine',
      date: '2020-03-20',
      time: '00:00:00'
    }
  },

Updating

To update the module to the latest version, use your terminal to go to your MMM-CountUP module folder and type the following command:

git pull

I've inspired in doing this module because of the COVID-19 Quarantine but you can use it for whatever you want

Feel free to open any Issue :smiley: