https://github.com/thomasjbradley/mmm-goodreads-challengecounts

Load the read & goal reading challenge stats from Goodreads to show on-screen.
https://github.com/thomasjbradley/mmm-goodreads-challengecounts

Last synced: 22 days ago
JSON representation

Load the read & goal reading challenge stats from Goodreads to show on-screen.

• Host: GitHub
• URL: https://github.com/thomasjbradley/mmm-goodreads-challengecounts
• Owner: thomasjbradley
• License: mit
• Created: 2023-10-12T15:26:06.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-27T02:22:06.000Z (about 1 year ago)
• Last Synced: 2024-04-14T22:12:05.381Z (7 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Goodreads reading challenge stats for MagicMirror

**Load the read & goal reading challenge stats from Goodreads to show on-screen.**

---

## Instal the module

To install, clone this repo into the `~/MagicMirror/modules` directory. Then move into the folder and install the required dependencies.

```

cd ~/MagicMirror/modules

git clone https://github.com/thomasjbradley/MMM-Goodreads-ChallengeCounts

cd MMM-Goodreads-ChallengeCounts

npm install

```

## Set up the module

Set up the module by adding the following configuration block to the modules array in your `config/config.js` file:

```js

var config = {

    modules: [

        {

            module: 'MMM-Goodreads-ChallengeCounts',

            position: 'bottom_left',

            config: {

              challenges: [

                ["Liz", "https://www.goodreads.com/user_challenges/41332601"],

                ["Thomas", "https://www.goodreads.com/user_challenges/40779579"],

              ],

            }

        }

    ]

}

```

## Config options

| Option         | Description                                                                        |

| -------------- | ---------------------------------------------------------------------------------- |

| challenges     | An array of arrays: each sub-array having the reader’s name & shared challenge URL |

| updateInterval | *Optional* How often to update the win stats; Default 15 minutes                   |