From c8cfc6d74a632fec51dd67dc1a62ab52f69cafd8 Mon Sep 17 00:00:00 2001 From: Pierre Brisorgueil Date: Wed, 20 Mar 2019 10:11:45 +0100 Subject: [PATCH] feat(readme): add api informations :books: --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ea0c678c..6a7bac71 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Our stack node is actually in Beta. | Testing | [Jest](https://github.com/facebook/jest) & [SuperTest](https://github.com/visionmedia/supertest) (Coverage & Watch)
*example of mocha with gulp available* | Linter | [ESLint](https://github.com/eslint/eslint) ecmaVersion 10 (2019) | Security | JWT Stateless - [passport-jwt](https://github.com/themikenicholson/passport-jwt)
Passwords - [zxcvbn](https://github.com/dropbox/zxcvbn)
DataBases options available (auth, ssl ..)
SSL options availble +| API | Default answer wrapper (helper) : [jsend](https://github.com/omniti-labs/jsend) like : status, message, data or error
Default error handling (helper) : formatted by the controller, Custom ES6 errors for other layers | CI | [Travis CI](https://travis-ci.org/weareopensource/Node) | Developer | [Coveralls](https://coveralls.io/github/weareopensource/Node) - [Code Climate](https://codeclimate.com/github/weareopensource/Node) - [Dependency status](https://david-dm.org/weareopensource/node) - [GreenKeeper](https://greenkeeper.io) - [Snyk](https://snyk.io/test/github/weareopensource/node) - [standard-version](https://github.com/conventional-changelog/standard-version) - [commitlint](https://github.com/conventional-changelog/commitlint) | Dependencies | [npm](https://www.npmjs.com) or [Yarn](https://yarnpkg.com/en/) @@ -41,6 +42,7 @@ Our stack node is actually in Beta. | **In reflexion** | | Documentation | Swagger
Docco | Developer | uses v8's builtin `debug` and `inspect` optionse +| API | evolution & version guideline ## Features Overview