Deleted unused dependency, added instructions in README and added a s…

…creenshot.
Menturan · Nov 7, 2018 · 5ba005b · 5ba005b
1 parent 746c5ba
commit 5ba005b
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
 # MMM-Namnsdag
-# UNDER CONSTRUCTION
+Magic Mirror module that displays Swedish names of the day. Relys on [Svenska Dagar Api](https://api.dryg.net/).
+
+## Screenshot
+![Screenshot](screenshot.png)
+
+## Install
+This module uses Yarn.
+1. `yarn install`
+
+## Configuration
+
+| Key | Value | Required | Default | Description | 
+|-----|-------|---------|---------|---------|
+|debug|_boolean_| N| false| Debug output. |
+
+## Example config
+
+``` json
+{
+    module: "MMM-Namnsdag",
+    position: 'bottom_right',
+}
+```
+## Development
+This module isn't perfect. If you find a bug or has a feature request don't hesitate to create an issue OR even better, create a pull request! :D
+
diff --git a/package.json b/package.json
@@ -1,6 +1,5 @@
 {
   "dependencies": {
-    "moment": "2.22.2",
     "node-fetch": "2.2.1",
     "request": "2.88.0"
   }

diff --git a/screenshot.png b/screenshot.png
diff --git a/yarn.lock b/yarn.lock
@@ -208,11 +208,6 @@ mime-types@^2.1.12, mime-types@~2.1.19:
   dependencies:
     mime-db "~1.37.0"
 
-moment@2.22.2:
-  version "2.22.2"
-  resolved "https://registry.yarnpkg.com/moment/-/moment-2.22.2.tgz#3c257f9839fc0e93ff53149632239eb90783ff66"
-  integrity sha1-PCV/mDn8DpP/UxSWMiOeuQeD/2Y=
-
 node-fetch@2.2.1:
   version "2.2.1"
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.2.1.tgz#1fe551e0ded6c45b3b3b937d0fb46f76df718d1e"