kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-12-12 18:02:15 +00:00
Code Issues Projects Releases Wiki Activity

Simplify "Module Creators" section

Kristjan ESPERANTO
2025-03-04 15:22:20 +01:00
parent d412c0bc5f
commit c75451dca0
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
3rd-Party-Modules.md

@@ -20,15 +20,15 @@ There is always a need for more modules. Check out the [forum](https://forum.mag
### Create your own module
If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](https://docs.magicmirror.builders/development/introduction.html). When you're done, just edit this page and add your module to the list!
If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](https://docs.magicmirror.builders/development/introduction.html).
When you're done, just edit this page and add your module to the list!
Don't forget to present your module in the [forum](https://forum.magicmirror.builders/category/5/modules).
### 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.**
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.
@@ -36,8 +36,6 @@ Therefore, **we highly recommend you to include the following information in you
- Whether the API/request require a key and the user limitations of those. (Is it free?)
- What is the current development status (WIP, searching for new maintainer or abandoned).
Surely this also help you get better recognition and feedback for your work.
## Module List
The following modules are maintained by their respective authors. If you have a GitHub account, don't forget [to star ⭐](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars#starring-a-repository) the modules you like!