Skip to content

A module for the MagicMirror² which creates a table with intractable unread GitHub notifications.

Notifications You must be signed in to change notification settings

ByteExceptionM/MMM-GitHub-Notifications

Repository files navigation

MMM-GitHub-Notifications

MagicMirror Module which creates a table with intractable unread GitHub notifications.

Installation

  1. Clone this repository inside your MagicMirror's modules folder

    cd ~/MagicMirror/modules

    git clone https://github.com/ByteExceptionM/MMM-GitHub-Notifications.

Config

You can add the following options to the config.js file:

Option Description
authToken The GitHub authentication token for the requests.

Type: string
Required: true
updateInterval Interval of updating notifications.

Type: int(milliseconds)
Default: 60.000 milliseconds
maxContentLength Maximum length of notification content.

Type: int
Default: 30
maxNotifications Maximum of shown notifications.

Type: int
Default: 5
Max: 20

Here is an example of an entry in config.js

{
	module: "MMM-GitHub-Notifications",
	position: "top_center",
	config: {
		authToken: "GITHUB AUTH TOKEN",
	}
},

About

A module for the MagicMirror² which creates a table with intractable unread GitHub notifications.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published