diff --git a/readme.md b/readme.md index 638c2a6..181b8b3 100644 --- a/readme.md +++ b/readme.md @@ -28,10 +28,19 @@ project | +--production.js +--models +--routes ++--start.js ``` The `config` directory contains a master config file with all of your default configuration, and another config file with overrides for each environment you plan to use. The `models` directory contains your models, which are used to automatically build the API endpoints. The `routes` directory is optional, and can contain "resources" which allow you to build custom endpoints not directly tied to a model. +Starting up the project is easy. Your start.js file should look something like this: + +###### ./start.js + +```javascript +require('dagger.js').initialize(__dirname); +``` + ### Models Models are designed using a beefed up [mongoose](http://mongoosejs.com/) system. A basic model in Dagger looks something like this: