/MMM-TBF

Primary LanguageJavaScript

MMM-TBF

Introduction

MMM-TBF is a MagicMirror2 module that displays abbreviations and their full form from a JSON data file. The abbreviations are shown in a randomized order, making it an interactive and educational addition to your MagicMirror2 setup. The default list of abbreviations is a list of Norwegian Defence terms. The name TBF is short for the Norwegian word TreBokstavsForkortelse, three letter abbreviation.

Screenshot

Installation

  1. Navigate to your MagicMirror's modules directory:

    cd ~/MagicMirror/modules
  2. Clone the MMM-TBF repository:

    git clone https://github.com/ItsMeBrille/MMM-TBF.git

Configuration

To use MMM-TBF, add it to your MagicMirror configuration file (usually located at config/config.js):

{
  module: "MMM-TBF",
  position: "top_bar", // Adjust the position as needed
  config: {
    // Optional configuration options:
    // updateInterval: 15, // Update interval in seconds (default: 15)
    // url: "abbreviations.json", // URL to the JSON data file (default: abbreviations.json)
    // randomOrder: true, // Display words in random order (default: true)
  }
},

License

This project is licensed under the MIT License - see the LICENSE file for details.