feat(jsdoc2md): add jsdoc2md support, and README template

Author: mbroadst

etc/README.hbs

@@ -0,0 +1,51 @@
+Kerberos
+========
+[![Build Status](https://travis-ci.org/mongodb-js/kerberos.svg?branch=master)](https://travis-ci.org/mongodb-js/kerberos)
+
+The `kerberos` package is a C++ extension for Node.js that provides cross-platform support for kerberos authentication using GSSAPI on linux/osx, and SSPI on windows. Much of the code in this module is adapted from [ccs-kerberos](https://github.com/apple/ccs-pykerberos) and [winkerberos](https://github.com/mongodb-labs/winkerberos).
+
+### Requirements
+
+**Linux**
+- `python` v2.7
+- `make`
+- A proper C/C++ compiler toolchain, like [GCC](https://gcc.gnu.org/)
+- Distribution-specific kerberos packages (e.g. `krb5-dev` on Ubuntu)
+
+**macOS**
+- `Xcode Command Line Tools`: Can be installed with `xcode-select --install`
+- Distribution-specific kerberos packages (e.g. `krb5` on Homebrew)
+
+**Windows**
+- **Option 1:** Install all the required tools and configurations using Microsoft's [windows-build-tools](https://github.com/felixrieseberg/windows-build-tools) by running `npm install -g windows-build-tools` from an elevated PowerShell (run as Administrator).
+- **Option 2:** Install dependencies and configuration manually
+   1. Visual C++ Build Environment:
+     * **Option 1:** Install [Visual C++ Build Tools](http://go.microsoft.com/fwlink/?LinkId=691126) using the *Default Install* option.
+     * **Option 2:** Install [Visual Studio 2015](https://www.visualstudio.com/products/visual-studio-community-vs) (or modify an existing installation) and select *Common Tools for Visual C++* during setup.
+
+  > :bulb: [Windows Vista / 7 only] requires [.NET Framework 4.5.1](http://www.microsoft.com/en-us/download/details.aspx?id=40773)
+
+  2. Install [Python 2.7](https://www.python.org/downloads/) or [Miniconda 2.7](http://conda.pydata.org/miniconda.html) (`v3.x.x` is not supported), and run `npm config set python python2.7`
+  3. Launch cmd, `npm config set msvs_version 2015`
+
+### Installation
+
+Now you can install `kerberos` with the following:
+
+```bash
+npm install kerberos
+```
+
+### Testing
+
+Run the test suite using:
+
+```bash
+npm test
+```
+
+NOTE: The test suite requires an active kerberos deployment, see `test/scripts/travis.sh` to better understand these requirements.
+
+# Documentation
+
+{{>main}}

package.json

@@ -20,8 +20,10 @@
     "chai": "^4.1.2",
     "chai-string": "^1.4.0",
     "clang-format": "^1.2.3",
+    "dmd-clear": "^0.1.2",
     "eslint": "^4.19.1",
     "eslint-plugin-prettier": "^2.6.0",
+    "jsdoc-to-markdown": "^4.0.1",
     "mocha": "^5.2.0",
     "mongodb": "^3.1.1",
     "prettier": "^1.13.5",
@@ -34,7 +36,8 @@
     "format-js": "prettier --print-width 100 --tab-width 2 --single-quote --write index.js 'test/**/*.js' 'lib/**/*.js'",
     "lint": "eslint index.js lib test",
     "precommit": "check-clang-format",
-    "test": "mocha ./test"
+    "test": "mocha ./test",
+    "docs": "jsdoc2md --template etc/README.hbs --plugin dmd-clear --files lib/kerberos.js > README.md"
   },
   "author": "Christian Amor Kvalheim",
   "license": "Apache-2.0",