Merge pull request #2 from crisvdn/feature/add-readme

Feature/add readme

MMM-MTG.js

@@ -4,20 +4,19 @@ const commander = '/cards/random?q=is%3Acommander';
 
 Module.register("MMM-MTG", {
     defaults: {
-        text: "MTG",
         sizePx: '450px',
         showCommandersOnly: true,
-        interval: 1,
+        FetchInterval: 1,
     },
     imageUri: "",
     requiresVersion: "2.25.0",
 
     start: async function() {
       this.getData();
-      if(this.config.interval > 0){
+      if(this.config.FetchInterval > 0){
         setInterval(() => {
           this.getData();
-        }, this.config.interval * 60000);
+        }, this.config.FetchInterval * 60000);
       }
     },
 

README.md

@@ -1 +1,39 @@
-# MMM-MTG
+# MMM-MTG
+
+## Introduction
+
+This module fetches a MTG random card from Scryfall.
+Depending on configurations, it will fetch commanders only (legendary creatures) or random cards.
+
+![Example of MTG module](images/example.png?raw=true "Example")
+
+
+## configuration
+
+Minimal configuration
+```json
+{
+    module: "MMM-MTG",
+    position: "bottom_right", // location
+},
+```
+
+
+| Configuration | values | summary | default |
+| ----- | ------ | ----- | ----- |
+| showCommandersOnly | `true/false` | Shows legendary creatures only or random cards | `true` |
+| FetchInterval | 0-X | Fetch interval in minutes. 0 is disabled. | 1 |
+| sizePx | 0-X px | Max size in height (string) | `450px` |
+
+Example configuration
+```json
+{
+    module: "MMM-MTG",
+    position: "bottom_right", // location
+    config: {
+        showCommandersOnly: false,
+        FetchInterval: 10, // every 10 minutes
+        sizePx: "300px", //
+    }
+},
+```