From 07e4b26b9e61bc2aea17c526c179699ae035f9d6 Mon Sep 17 00:00:00 2001 From: "E:V:A" Date: Sat, 6 Jan 2018 19:57:46 +0200 Subject: [PATCH] Added general advice --- modules/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/modules/README.md b/modules/README.md index 76973996..b9cc7dcd 100644 --- a/modules/README.md +++ b/modules/README.md @@ -2,6 +2,18 @@ This document describes the way to develop your own MagicMirror² modules. +## General Advice + +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 modules does, how it looks and what it depends on. Unfortunately, this information is rarely available, nor easily obtained without having to install it first. +Therefore **we highly recomend 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 +- Wheteher the API/request require a key and the user limitations of those. (Is it free?) + +Surely this also help you get better reconition and feedback for your work. + ## Module structure All modules are loaded in the `modules` folder. The default modules are grouped together in the `modules/default` folder. Your module should be placed in a subfolder of `modules`. Note that any file or folder your create in the `modules` folder will be ignored by git, allowing you to upgrade the MagicMirror² without the loss of your files.