diff --git a/README.md b/README.md index 4b4b920..b38c54b 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,13 @@ [![Coverage Status](https://coveralls.io/repos/github/christroutner/babel-free-koa2-api-boilerplate/badge.svg?branch=unstable)](https://coveralls.io/github/christroutner/babel-free-koa2-api-boilerplate?branch=unstable) -[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Greenkeeper badge](https://badges.greenkeeper.io/christroutner/babel-free-koa2-api-boilerplate.svg)](https://greenkeeper.io/) +[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) + +[![Greenkeeper badge](https://badges.greenkeeper.io/christroutner/babel-free-koa2-api-boilerplate.svg)](https://greenkeeper.io/) Boilerplate for building APIs with [koa2](https://github.com/koajs/koa/tree/v2.x) and mongodb. -This repository is based on Adrian Obelmejias' [koa-api-boilerplate repository](https://github.com/adrianObel/koa2-api-boilerplate). +This repository is forked from Adrian Obelmejias' [koa-api-boilerplate repository](https://github.com/adrianObel/koa2-api-boilerplate). It makes the following modifications: - Remove babel as a dependency. This repository is now natively compatible with @@ -16,6 +18,8 @@ It makes the following modifications: - Replaced `bcrypt` dependency with `bcryptjs`. This improves compatibility across versions of node.js and across OSs. +- Configured for Travis CI (continuous integration), Coveralls (code coverage), GreenKeeper (automated dependency management), and Semantic Release (automated versioning). + ## Features This project covers basic necessities of most APIs. * Authentication (passport & jwt)