From 5c0cec3d9cf24e1343d09e48a8a6e5544f3646d5 Mon Sep 17 00:00:00 2001 From: Adrian Obelmejias Date: Fri, 4 Mar 2016 21:01:13 -0500 Subject: [PATCH] Add apidoc config --- apidoc.json | 7 +++++++ package.json | 4 +++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 apidoc.json diff --git a/apidoc.json b/apidoc.json new file mode 100644 index 0000000..0560858 --- /dev/null +++ b/apidoc.json @@ -0,0 +1,7 @@ +{ + "name": "koa2-api-boilerplate", + "version": "1.1.0", + "description": "Koa2 boilerplate covering essentials for APIs", + "title": "koa2-api-boilerplate", + "url" : "https://github.com/adrianObel/koa2-api-boilerplate" +} diff --git a/package.json b/package.json index 49d3c76..cfb8943 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ "start": "node index.js", "dev": "./node_modules/.bin/nodemon index.js", "test": "NODE_ENV=test ./node_modules/.bin/mocha --compilers js:babel-register --require babel-polyfill", - "lint": "eslint src/**/*.js" + "lint": "eslint src/**/*.js", + "docs": "./node_modules/.bin/apidoc -i src/ -o docs" }, "keywords": [ "koa2-api-boilerplate", @@ -40,6 +41,7 @@ "passport-local": "^1.0.0" }, "devDependencies": { + "apidoc": "^0.15.1", "babel-eslint": "^4.1.8", "babel-register": "^6.5.1", "chai": "^3.5.0",