diff --git a/README.md b/README.md index f1857c9af..9549f88d2 100644 --- a/README.md +++ b/README.md @@ -27,30 +27,30 @@ npm test Granular: -Lint: `npm run lint` -All BDD: `npm run bdd` -Pass additional arguments to BDD: `npm run bdd -- -d` -BDD one file: `npm run bdd -- test/path/to/file.js` -BDD Watch: `npm run bdd-watch` -BDD Watch w/ one test file: `npm run bdd-watch -- test/path/to/file.js` -All Unit: `npm run unit` +Lint: `npm run lint` +All BDD: `npm run bdd` +Pass additional arguments to BDD: `npm run bdd -- -d` +BDD one file: `npm run bdd -- test/path/to/file.js` +BDD Watch: `npm run bdd-watch` +BDD Watch w/ one test file: `npm run bdd-watch -- test/path/to/file.js` +All Unit: `npm run unit` Opinions ======== #### Restful resource urls -Create - POST - /resources -Read - GET - /resources/:id -Update - PATCH - /resources/:id *PATCH is a partial update, PUT is a full resource update -Delete - DELETE - /resources/:id +Create - POST - /resources +Read - GET - /resources/:id +Update - PATCH - /resources/:id *PATCH is a partial update, PUT is a full resource update +Delete - DELETE - /resources/:id #### Middleware Patterns -Request Data validation and Middleware Flow Control - [tjmehta/dat-middleware](https://github.com/tjmehta/dat-middleware) -Middleware Flow Control - [tjmehta/middleware-flow](https://github.com/tjmehta/middleware-flow) -Middlewares of models are autogenerated for you -* Mongoose Models - /lib/middlewares/mongo/index.js - [tjmehta/mongooseware](https://github.com/tjmehta/mongooseware) -* Class Models - /lib/middlewares/apis/index.js [tjmehta/middlewarize](https://github.com/tjmehta/middlewarize) *documentation soon -Sharing the request object as a common context between middlewares allows us to make -asyncronous code look syncronous and avoid "callback hell" +Request Data validation and Middleware Flow Control - [tjmehta/dat-middleware](https://github.com/tjmehta/dat-middleware) +Middleware Flow Control - [tjmehta/middleware-flow](https://github.com/tjmehta/middleware-flow) +Middlewares of models are autogenerated for you +* Mongoose Models - /lib/middlewares/mongo/index.js - [tjmehta/mongooseware](https://github.com/tjmehta/mongooseware) +* Class Models - /lib/middlewares/apis/index.js [tjmehta/middlewarize](https://github.com/tjmehta/middlewarize) +Sharing the request object as a common context between middlewares allows us to make +asyncronous code look syncronous and avoid "callback hell" #### Boom for Http Errors Nice Http Error library - [spumko/boom](https://github.com/spumko/boom)