build(markdown-lint): added a linter for markdown

Author: travi

.markdownlintrc

@@ -0,0 +1,4 @@
+{
+  "commands-show-output": false,
+  "no-inline-html": false
+}

README.md

@@ -1,5 +1,4 @@
-travi-api
-=========
+# travi-api
 
 [![license](https://img.shields.io/github/license/travi/travi-api.svg)](LICENSE)
 [![Build Status](https://img.shields.io/travis/travi/travi-api.svg?style=flat)](https://travis-ci.org/travi/travi-api)
@@ -11,29 +10,34 @@ travi-api
 ![greenkeeper badge](https://badges.greenkeeper.io/GainCompliance/hapi-auth-stormpath.svg)
 
 ## Try It
-You can interact with the api through the [Swagger UI instance](https://api.travi.org/documentation) hosted with the API.
+
+You can interact with the api through the [Swagger UI instance](https://api.travi.org/documentation)
+hosted with the API.
 
 ## Project Goals
 
-I'm using this as an opportunity to learn how to apply a number of core concepts of api development to node.
+I'm using this as an opportunity to learn how to apply a number of core concepts
+of api development to node.
 
-- [x] <abbr title="Hypertext Application Language">[HAL](http://stateless.co/hal_specification.html)</abbr> compatible Hypermedia/HATEOAS API
-    * [Hapi](http://hapijs.com/)
-    * [Halacious](https://github.com/bleupen/halacious)
+- [x] <abbr title="Hypertext Application Language">[HAL](http://stateless.co/hal_specification.html)</abbr>
+  compatible Hypermedia/HATEOAS API
+  - [Hapi](http://hapijs.com/)
+  - [Halacious](https://github.com/bleupen/halacious)
 - [ ] Access Control
-    - [x] Limited read-only access with no auth context
-    - [ ]  Privilege elevation for advanced actions
-        * Either OAuth or [Oz](https://github.com/hueniverse/oz) for authorization
+  - [x] Limited read-only access with no auth context
+  - [ ]  Privilege elevation for advanced actions
+    - Either OAuth or [Oz](https://github.com/hueniverse/oz) for authorization
 - [ ] Consumer Driven Contracts
-    - [ ] Pact Provider
-    - [x] Leverage the [broker](https://pact-api.travi.org) the share pacts from consumers
+  - [ ] Pact Provider
+  - [x] Leverage the [broker](https://pact-api.travi.org) the share pacts from consumers
 
 ## Local Development
 
 ### Environment variables
 
-This application uses environment variables for certain configuration. For local development, the npm script `dev` expects
-a `.env` file to exist, as described [here](https://devcenter.heroku.com/articles/heroku-local#set-up-your-local-environment-variables)
+This application uses environment variables for certain configuration. For local
+development, the npm script `dev` expects a `.env` file to exist, as described
+[here](https://devcenter.heroku.com/articles/heroku-local#set-up-your-local-environment-variables)
 and contain the necessary variable definitions.
 
 ### Database

package.json

@@ -6,6 +6,7 @@
   "repository": "travi/travi-api",
   "scripts": {
     "lint:js": "eslint .",
+    "lint:md": "globstar --node -- markdownlint **/*.md",
     "tests:unit": "mocha --recursive test/unit",
     "tests:integration": "cucumber.js test/integration --compiler js:babel-register --tags 'not @wip'",
     "tests:integration:wip": "cucumber.js test/integration --compiler js:babel-register --tags @wip",
@@ -37,13 +38,15 @@
     "dotenv": "2.0.0",
     "dotenv-safe": "3.0.0",
     "formatio": "1.2.0",
+    "globstar": "1.0.0",
     "grunt": "1.0.1",
     "grunt-babel": "6.0.0",
     "grunt-cli": "1.2.0",
     "grunt-flyway": "travi/grunt-flyway#credentials",
     "hoek": "4.1.0",
     "husky": "0.12.0",
     "load-grunt-config": "0.19.2",
+    "markdownlint-cli": "0.2.0",
     "mocha": "3.2.0",
     "npm-run-all": "3.1.2",
     "nyc": "10.0.0",