Skip to content

C-Deck/MMM-GHIN

Repository files navigation

Magic Mirror Module GHIN

The GHIN module is a MagicMirror addon. This module displays your official USGA handicap on your MagicMirror.

How to use this module

  1. Clone this repo with the following command: git clone https://github.com/C-Deck/MMM-GHIN.git
  2. Install all the npm modules with either yarn install or npm install
  3. Update your Magic Mirror Config, by adding the following object: To use this module, add it to the modules array in the config/config.js file:
modules: [
  {
    module: 'MMM-GHIN',
    position: 'bottom_bar',
    config: {
      ghinNumber: '00000000', // Your GHIN Number
      updateInterval: 37000, // Update interval in milliseconds,
      email: 'johndoe@gmail.com', // Your login email for GHIN
      password: 'password', // Your login password for GHIN
    },
  },
]

🛠️ Config

  • module the name of the module you are installing.
  • position where you want the handicap value to appear
  • ghinNumber Your specific GHIN Number
  • updateInterval default is set to 5 minutes
  • email Your email for logging in on your GHIN account
  • password Your password for logging in on your GHIN account

✨ Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Clint Decker

⚖️ License

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

About

GHIN Golf Module for MagicMirror2

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published