📚 Updated documentation, added Markdownlint in CircleCI (#10)

.codeclimate.yml

@@ -4,8 +4,9 @@ engines:
     enabled: true
   shellcheck:
     enabled: true
+  markdownlint:
+    enabled: true
 ratings:
-  paths: [
-    "**.sh"
-  ]
+  paths:
+  - "**.sh"
 exclude_paths: []

.github/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-## Problem/Motivation
+# Problem/Motivation
 
 > (Why the issue was filed)
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-## Proposed Changes
+# Proposed Changes
 
 > (Describe the changes and rationale behind them)
 

.mdlrc

@@ -0,0 +1 @@
+rules "~MD024"

CONTRIBUTING.md

@@ -21,7 +21,7 @@ Even better: You could submit a pull request with a fix / new feature!
 1. Search our repository for open or closed [pull requests][prs] that relates
    to your submission. You don't want to duplicate effort.
 
-2. You may merge the pull request in once you have the sign-off of two other
+1. You may merge the pull request in once you have the sign-off of two other
    developers, or if you do not have permission to do that, you may request
    the second reviewer to merge it for you.
 

README.md

@@ -14,7 +14,7 @@
 This is a build environment for building Hass.io Docker images and is
 capable of building Docker images for multiple architectures.
 
-_Note: This build environment is **HIGHLY EXPERIMENTAL**! It still needs
+Note: _This build environment is **HIGHLY EXPERIMENTAL**! It still needs
 a lot of testing, and the documentation is far from complete. Use at your
 own risk!_
 
@@ -27,7 +27,7 @@ need for "large" and complicated Bash scripts (as provided by Home Assistant).
 ```bash
 docker run -it --rm --privileged --name buildenv \
     -v ~/.docker:/root/.docker \
-    -v ".":/docker \
+    -v "$(pwd)":/docker \
     hassioaddons/build-env:latest \
     [options]
 ```
@@ -260,7 +260,7 @@ The original setup of this repository is by [Franck Nijhof][frenck].
 For a full list of all authors and contributors,
 check [the contributor's page][contributors].
 
-## Looking for Hass.io add-ons?
+## We've got some Hass.io add-ons for you
 
 Want some more functionality to your Hass.io Home Assistant instance?