Skip to content

Commit 2c747bd

Browse files
Updated documentation
1 parent 9c93b62 commit 2c747bd

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
#KOACH
2-
3-
Production ready boilerplate for building APIs with [koa2] and mongodb.
1+
## KOACH
2+
Production ready boilerplate for building APIs with [koa2](https://github.com/koajs/koa/) and mongodb.
43

4+
## Description
55
This project covers basic necessities of most APIs.
66
* Authentication (passport & jwt)
77
* Database (mongoose)
88
* Testing (mocha)
99
* Doc generation with apidoc
1010
* linting using standard
1111

12-
##Requirements
12+
## Requirements
1313
* node > v7.8.0
1414

15-
##Installation
15+
## Installation
1616
```bash
1717
git clone
1818
```
1919

20-
##Features
20+
## Features
2121
* [koa2](https://github.com/koajs/koa)
2222
* [koa-router](https://github.com/alexmingoia/koa-router)
2323
* [koa-bodyparser](https://github.com/koajs/bodyparser)
@@ -32,7 +32,7 @@ git clone
3232
* [Babel](https://github.com/babel/babel)
3333
* [ESLint](http://eslint.org/)
3434

35-
##Structure
35+
## Structure
3636
```
3737
├── bin
3838
│ └── server.js # Bootstrapping and entry point
@@ -54,19 +54,19 @@ git clone
5454
└── test # Unit tests
5555
```
5656

57-
##Usage
57+
## Usage
5858
* `npm start` Start server on live mode
5959
* `npm run dev` Start server on dev mode with nodemon
6060
* `npm run docs` Generate API documentation
6161
* `npm test` Run mocha tests
6262

63-
##Documentation
63+
## Documentation
6464
API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
6565

6666
Visit `http://localhost:3000/docs/` to view docs
6767

68-
##Contributors
68+
## Contributors
6969
Systango, Arpit Khandelwal
7070

71-
##License
71+
## License
7272
MIT

0 commit comments

Comments
 (0)