From 6248d48890bbe229ebb1ba63f2f7b386914c80e2 Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Mon, 5 Mar 2018 19:43:00 -0800 Subject: [PATCH] Updating readme --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b25d07e..e14d640 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,16 @@ This project covers basic necessities of most APIs. * Doc generation with apidoc * linting using standard -##Requirements -* node __^4.0.0__ -* npm __^3.0.0__ +## Requirements +* node __^8.9.4__ +* npm __^5.7.1__ -##Installation +## Installation ```bash -git clone https://github.com/adrianObel/koa2-api-boilerplate.git +git clone https://github.com/christroutner/babel-free-koa2-api-boilerplate.git ``` -##Features +## Features * [koa2](https://github.com/koajs/koa/tree/v2.x) * [koa-router](https://github.com/alexmingoia/koa-router) * [koa-bodyparser](https://github.com/koajs/bodyparser) @@ -38,7 +38,7 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git * [apidoc](http://apidocjs.com/) * [ESLint](http://eslint.org/) -##Structure +## Structure ``` ├── bin │ └── server.js # Bootstrapping and entry point @@ -60,16 +60,16 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git └── test # Unit tests ``` -##Usage +## Usage * `npm start` Start server on live mode * `npm run dev` Start server on dev mode with nodemon * `npm run docs` Generate API documentation * `npm test` Run mocha tests -##Documentation +## Documentation API documentation is written inline and generated by [apidoc](http://apidocjs.com/). Visit `http://localhost:5000/docs/` to view docs -##License +## License MIT