Documentation

.codeclimate.yml

@@ -5,7 +5,7 @@ engines:
     enabled: true
     config:
       languages:
-      - javascript
+        - javascript
   eslint:
     enabled: true
     channel: "eslint-3"
@@ -18,9 +18,8 @@ engines:
     enabled: true
 ratings:
   paths:
-  - "**.css"
-  - "**.js"
-  - "**.md"
-exclude_paths: [
-  "node_modules/**/*"
-]
+    - "**.css"
+    - "**.js"
+    - "**.md"
+exclude_paths:
+  - "node_modules/**/*"

.doclets.yml

@@ -0,0 +1,9 @@
+dir: .
+packageJson: package.json
+articles:
+  - Overview: README.md
+  - Changelog: CHANGELOG.md
+  - License: LICENSE
+branches:
+  - master
+  - develop

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[{*.json, *.yml}]
+indent_style = space
+indent_size = 2

.eslintignore

@@ -0,0 +1 @@
+docs/*

.eslintrc

@@ -4,7 +4,8 @@
     "comma-dangle": 0,
 	"indent": [2, 4],
     "max-len": [2, 120, { "ignoreStrings": true }],
-    "radix": [2, "as-needed"]
+    "radix": [2, "as-needed"],
+    "no-console": 0
   },
   "settings": {
     "import/core-modules": [ "node_helper" ]
@@ -14,4 +15,4 @@
     "node": true,
     "es6": true
   }
-}
+}

.github/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contribution Guidelines
+
+Thanks for contributing to this module!
+
+Please create pull requests to the branch `develop`.
+
+To hold one code style and standard there are several linters and tools in this project set. Make sure you fullfill the requirements.
+Also there will be automatically analysis performed once you created the pull request.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+Platform (Hardware/OS):
+
+Node version:
+
+MagicMirror version:
+
+Module version:
+
+Description of the issue:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Please create pull requests to the branch `develop`.
+
+* Does the pull request solve an issue (add a reference)?
+* What are the features of this pr?
+* Add screenshots for visual changes.

.mdlrc

@@ -1,2 +1,2 @@
 all
-rules "~MD013", "~MD033"
+rules "~MD013", "~MD024", "~MD026", "~MD033"

.stylelintrc

@@ -3,4 +3,4 @@
 	"rules": {
 		"indentation": 4
 	}
-}
+}

.travis.yml

@@ -4,4 +4,7 @@ node_js:
  - "9"
  - "10"
 script:
- - npm run lint
+ - npm run lint
+cache:
+  directories:
+    - node_modules

CHANGELOG.md

@@ -0,0 +1,27 @@
+# MMM-soccer Changelog
+
+## [2.0.0]
+
+### Added
+
+* Club logo downloader
+* New config option `logos`.
+* Documentation
+* [Doclets.io](https://doclets.io/fewieden/MMM-soccer/master) integration
+* Contributing guidelines
+* Issue template
+* Pull request template
+* Editor config
+
+### Changed
+
+* Switched from Api v1 to v2.
+* Updated league ids.
+* Switched rendering from js to nunjuck template.
+* Updated travis-ci config.
+* Disabled markdown lint rules `MD024` and `MD026`
+
+
+## [1.0.0]
+
+Initial version