kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-07-01 13:33:15 +00:00
Code Issues Projects Releases Wiki Activity

Added 3rd party general advice

E:V:A 2018-01-06 20:13:50 +02:00
parent 7b6fb11e17
commit 2ffbe3a270
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
MagicMirror²-Modules.md

@ -32,10 +32,25 @@ To install 3rd party or your own custom modules just follow these steps:
},
```
to the list of modules. You can look at the default modules for examples and further details can be found on the main readme.
to the list of modules. You can look at the default modules for examples and further details can be found on the main README.
## 3rd party module authors
There is always a need for more modules. Check out the forums to see what people are requesting. If you've created an module, feel free to edit this page and add your module to the list.
There is always a need for more modules. Check out the forums to see what people are requesting. If you have created an module, feel free to edit this page and add your module to the list.
### General Advice
As **MagicMirror is a fantastic project that is highly connected with aesthetics**, it is surprising to see how few module developers actually bother to put a screenshot on their README pages. As MM has gained huge popularity, so has the number of available modules. For new users and developers alike, it is very time consuming to navigate around the various repositories in order to find out what exactly a certain module does, how it looks and what it depends on. Unfortunately, more often than not, this information is rarely available nor easily obtained without having to install it.
Therefore, **we highly recommend you to include the following information in your README file.**
- **A high quality screenshot** of your working module
- A short, one sentence, clear description what it does (duh!)
- What external API's it depend on, including web links to those
- Whether the API/request require a key and the user limitations of those. (Is it free?)
- What is the current development status (WIP, completed, maintained or abandoned)
Surely this also help you get better recognition and feedback for your work.
## 3rd party modules:
The following modules are created by their respective authors.