Merge branch 'master' of https://github.com/jalibu/MMM-RAIN-MAP

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,101 @@
+name: Bug Report
+description: Think you found a bug? Let us know!
+labels: [bug, to check]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Hello and thank you for helping to improve this module.
+        Please make sure to only submit reproducible issues.
+
+  - type: input
+    attributes:
+      label: Platform
+      description: |
+        Tell us about the platform on which you run your MagicMirror.
+      placeholder: 'Raspberry Pi OS'
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Node.js Version
+      description: |
+        You'll get your Node.js version by executing `node -v` in your terminal.
+      placeholder: '14.17.5'
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: MagicMirror Version
+      description: |
+        Which version of MagicMirror are you running? It can be found in the `MagicMirror/package.log` file.
+      placeholder: '2.16.0'
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Module Version
+      description: |
+        What's the module's version / Commit ID? You can get this information by executing `git log` within the module's directory.
+      placeholder: 'v.2.0.2 or f8ae15ffb6b5e4f5d5f9cc436f8e697d02737982'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: Please describe the bug as clear and concise as possible. 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: What should actually happen?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Current behavior
+      description: What happened instead?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Possible solution
+      description: You can suggest a reason for the bug, if know about it.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Please give details about how do you reach that behavior
+      placeholder: |
+        1. Start MM...
+        2. Wait until everything loads
+        3. Click button...
+        4. See error...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Log
+      description: |
+        Paste the log you're getting, and possibly the error.
+        **Please don't forget to remove sensitive information!**
+      render: shell
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: config.js
+      description: |
+        Paste here your config.js file.
+        **Please don't forget to remove sensitive information!**
+      render: javascript
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Everything else that you think could be useful.
+    validations:
+      required: false

README.md

@@ -1,10 +1,12 @@
 # MMM-RAIN-MAP
+[![dependencies Status](https://status.david-dm.org/gh/jalibu/MMM-RAIN-MAP.svg)](https://david-dm.org/jalibu/MMM-RAIN-MAP)  [![Known Vulnerabilities](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jalibu/MMM-RAIN-MAP?targetFile=package.json) 
 
-A Rain Radar Map for [Magic Mirror](https://magicmirror.builders/) based on the [Rainviewer API](https://github.com/rainviewer/rainviewer-api-example).  
+A Rain Radar Map based on the [Rainviewer API](https://www.rainviewer.com/) for the [MagicMirror²](https://magicmirror.builders/) platform.
+
 Click here for the [Forum Thread](https://forum.magicmirror.builders/topic/12808/mmm-rain-map).
 
 #### Support
-If you like this module and want to thank, please buy me a coffee.
+If you like this module and want to thank, please rate this repository with a star or buy me a coffee :-)
 
 <a href="https://www.buymeacoffee.com/jalibu" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Beer" style="height: 45px !important;width: 180px !important;" ></a>
 
@@ -58,8 +60,8 @@ https://user-images.githubusercontent.com/25933231/130909536-e096d342-19d5-4139-
 				{ lat: 49.15, lng: 6.154, zoom: 5, loops: 2 },
 			],
 			mapUrl: "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
-			mapHeight: "420px",
-			mapWidth: "420px",
+			mapHeight: "420px", // must be a pixel value (no percent)
+			mapWidth: "420px", // must be a pixel value (no percent)
 			maxHistoryFrames: -1,
 			maxForecastFrames: -1,
 			substitudeModules: [],
@@ -83,8 +85,8 @@ https://user-images.githubusercontent.com/25933231/130909536-e096d342-19d5-4139-
 | `extraDelayCurrentFrameMs` | Add an extra delay to pause the animation on the frame for the current weather situation.<br><br>**Type:** `int` <br> **Default value:** `3000` (time in milliseconds)    |
 | `markers`               | Optional list of markers on the map.<br> See examples and Markers-Object documentation below for details. <br><br>**Type:** `array[Marker]` <br> **Default value:** `Sample set`           |
 | `mapPositions`         | **Required:** List of zoom/center positions for the map.<br> See examples and MapPosition-Object documentation below for details. <br><br>**Type:** `array[MapPosition]` <br> **Default value:** `Sample set`           |
-| `mapHeight`             | Height of the map. <br><br>**Type:** `string` (pixels) <br> **Default value:** `'420px'`                                                                                                                   |
-| `mapWidth`              | Width of the map. <br><br>**Type:** `string` (pixels) <br> **Default value:** `'420px'`                                                                                                                    |
+| `mapHeight`             | Height of the map. Must be string with pixels and "px" postfix. Percentage values won't work.<br><br>**Type:** `string` (pixels) <br> **Default value:** `'420px'`                                                                                                                   |
+| `mapWidth`              | Width of the map. Must be a string with pixels and "px" postfix. Percentage values won't work.<br><br>**Type:** `string` (pixels) <br> **Default value:** `'420px'`                                                                                                                    |
 | `mapUrl`        | Option to use an alternative map. In most cases you are fine with the default but you can find more maps [here](https://wiki.openstreetmap.org/wiki/Tile_servers).<br><br>**Type:** `string`<br> **Default value:** `'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'`<br>**Alternative uncolored map:** '`https://tiles.wmflabs.org/bw-mapnik/${z}/${x}/${y}.png`' |
 | `maxHistoryFrames`             | Maximum number of history frames. There is one frame every 10 minutes. Setting this to 6 would show history radar layers of the last hour until now. If set to -1, all available history frames are shown.<br>As of today, the **API provides 12 history frames** -> 2h.<br><br>**Type:** `int` <br> **Default value:** `-1`                                                                                                                   |
 | `maxForecastFrames`             | Maximum number of forecast frames. There is one frame every 10 minutes. Setting this to 2 would show forecast radar layers from now to 20 minutes in the future. If set to -1, all available forecast frames are shown.<br>As of today, the **API provides 3 forecast frames** -> 30min.<br><br>**Type:** `int` <br> **Default value:** `-1` 
@@ -121,4 +123,4 @@ Contribution for this module is welcome!
 
 - Thanks to all supporters who gave a small [donation](https://www.buymeacoffee.com/jalibu) out of gratitude for my work.
 - All testers for their feedback.
-- [MMM-RAIN-RADAR by jojoduquartier](https://github.com/jojoduquartier/MMM-RAIN-RADAR) for inspiration.
+- [MMM-RAIN-RADAR by jojoduquartier](https://github.com/jojoduquartier/MMM-RAIN-RADAR) for inspiration.