mirror of
https://github.com/edward-shen/MMM-pages.git
synced 2025-06-07 11:43:36 -07:00
Compare commits
No commits in common. "2cf512b70cd87c66e92842ff99369afcf2e7a7f2" and "2990f5b6574dd2438bda20b4bb5af8ba61813cae" have entirely different histories.
2cf512b70c
...
2990f5b657
1 changed files with 13 additions and 13 deletions
24
readme.md
24
readme.md
|
@ -1,6 +1,4 @@
|
|||
# MMM-pages
|
||||
|
||||
## Project status
|
||||
## Maintainer needed
|
||||
|
||||
This project is **mature** and in maintence mode only. New features or fixes
|
||||
will not be actively made. If you'd like to see a feature or fix, please
|
||||
|
@ -14,10 +12,12 @@ contribute to this repository before asking for maintainership. As this module
|
|||
is used by a lot of people, I need to ensure that a new maintainer can write
|
||||
high quality code and match the standards of the existing codebase.
|
||||
|
||||
## Description
|
||||
---
|
||||
|
||||
This [MagicMirror²][mm] module allows you to have pages in your MagicMirror!
|
||||
Want to have more modules in your MagicMirror, but want to keep the format?
|
||||
# MMM-pages
|
||||
|
||||
This [MagicMirror²][mm] Module allows you to have pages in your magic mirror!
|
||||
Want to have more modules in your magic mirror, but want to keep the format?
|
||||
Or, want to have grouped modules that are themed together? Look no further!
|
||||
|
||||

|
||||
|
@ -28,7 +28,7 @@ one yourself!
|
|||
|
||||
## Installation
|
||||
|
||||
In your terminal, go to your MagicMirror's module directory:
|
||||
In your terminal, go to your MagicMirror's Module folder:
|
||||
|
||||
```bash
|
||||
cd ~/MagicMirror/modules
|
||||
|
@ -37,7 +37,7 @@ cd ~/MagicMirror/modules
|
|||
Clone this repository:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/edward-shen/MMM-pages
|
||||
git clone https://github.com/edward-shen/MMM-pages.git
|
||||
```
|
||||
|
||||
Configure the module in your config.js file.
|
||||
|
@ -52,7 +52,6 @@ To display what page you're on, I'd highly recommend checking out my
|
|||
## Using the module
|
||||
|
||||
To use this module, add it to the modules array in the `config/config.js` file.
|
||||
|
||||
Note: module names used in the following example are fictitious.
|
||||
|
||||
```js
|
||||
|
@ -141,8 +140,8 @@ MMM-pages notifications.
|
|||
|
||||
### Initialization
|
||||
|
||||
*This section provides documentation on what notifications the module sends on
|
||||
startup. This section isn't necessary to read for most users.*
|
||||
_This section provides documentation on what notifications the module sends on
|
||||
startup. This section isn't necessary to read for most users._
|
||||
|
||||
MMM-pages doesn't activate until we receive the `DOM_OBJECTS_CREATED`
|
||||
notification, as that notification ensures all modules have been loaded. On this
|
||||
|
@ -190,5 +189,6 @@ See also FAQ below.
|
|||
|
||||
Please make an issue. Thanks!
|
||||
|
||||
[mm]: https://github.com/MagicMirrorOrg/MagicMirror
|
||||
[example_url]: https://www.youtube.com/watch?v=1NQ-sGtdUdg
|
||||
[mm]: https://github.com/MichMich/MagicMirror
|
||||
[page indicator]: https://github.com/edward-shen/MMM-page-indicator
|
||||
|
|
Loading…
Reference in a new issue