update readme

README.md

@@ -1,57 +1,40 @@
 [![Build Status](https://travis-ci.org/madhums/node-express-mongoose-demo.png)](https://travis-ci.org/madhums/node-express-mongoose-demo)
 
-**work in progress:** Migrating the demo to express 4 and swig - checkout [express4.x-swig](https://github.com/madhums/node-express-mongoose-demo/tree/express-4.x-swig) branch (its ready except that it doesn't have image upload yet)
-
 # Nodejs Express Mongoose Demo
 
 This is a demo node.js application illustrating various features used in everyday web development, with a fine touch of best practices. The demo app is a blog application where users (signing up using facebook, twitter, github and simple registrations) can create an article, delete an article and add comments on the article.
 
-Read the [wiki](https://github.com/madhums/node-express-mongoose/wiki) (or the [old blog post](http://madhums.me/2012/07/19/breaking-down-app-js-file-nodejs-express-mongoose/)) for the application architecture.
+## Boilerplate
 
 Want to build something from scratch? use the [boilerplate app](https://github.com/madhums/node-express-mongoose)
 
-Checkout the [apps that are built using this approach](https://github.com/madhums/node-express-mongoose/wiki/Apps-built-using-this-approach)
+* Checkout the [apps that are built using this approach](https://github.com/madhums/node-express-mongoose/wiki/Apps-built-using-this-approach)
+* The [wiki](https://github.com/madhums/node-express-mongoose/wiki) is wip, it has some information about the way application is setup.
 
-## Install
+## Requirements
 
-**NOTE:** You need to have node.js, mongodb and [imagemagick](http://www.imagemagick.org/script/index.php) installed and running.
+* [NodeJs](http://nodejs.org)
+* [mongodb](http://mongodb.org)
+* [imagemagick](http://www.imagemagick.org/script/index.php)
+
+## Install
 
 ```sh
-  $ git clone git://github.com/madhums/node-express-mongoose-demo.git
-  $ npm install
-  $ cp config/imager.example.js config/imager.js
-  $ npm start
+$ git clone git://github.com/madhums/node-express-mongoose-demo.git
+$ npm install
+$ cp config/imager.example.js config/imager.js
+$ npm start
 ```
 
-**NOTE:** Do not forget to update your facebook, twitter, google, linkedin and github `APP_ID` and `APP_SECRET` in `config/config.js`. Also if you want to use image uploads, don't forget to replace the S3 and Rackspace keys in `config/imager.js`.
-
-Then visit [http://localhost:3000/](http://localhost:3000/)
-
-## Related modules
+**NOTE:** Do not forget to set the facebook, twitter, google, linkedin and github `CLIENT_ID`s and `SECRET`s. In `development` env, you can simply copy
+`config/env/env.example.json` to `config/env/env.json` and just replace the
+values there. In production, it is not safe to keep the ids and secrets in
+a file, so you need to set it up via commandline. If you are using heroku
+checkout how environment variables are set [here](https://devcenter.heroku.com/articles/config-vars)
 
-1. [node-genem](https://github.com/madhums/node-genem) A module to generate the MVC skeleton using this approach.
-2. [node-notifier](http://github.com/madhums/node-notifier) - used for notifications via emails and push notificatiions
-3. [node-imager](http://github.com/madhums/node-imager) - used to resize, crop and upload images to S3/rackspace
-4. [node-view-helpers](http://github.com/madhums/node-view-helpers) - some common view helpers
-5. [mongoose-migrate](https://github.com/madhums/mongoose-migrate#readme) - Keeps track of the migrations in a mongodb collection (fork of visionmedia/node-migrate)
-6. [mongoose-user](http://github.com/madhums/mongoose-user) - Generic methods, statics and virtuals used for user schemas
+in `config/config.js`. Also if you want to use image uploads, don't forget to replace the S3 and Rackspace keys in `config/imager.js`.
 
-## Directory structure
-```
--app/
-  |__controllers/
-  |__models/
-  |__mailer/
-  |__views/
--config/
-  |__routes.js
-  |__config.js
-  |__passport.js (auth config)
-  |__imager.js (imager config)
-  |__express.js (express.js configs)
-  |__middlewares/ (custom middlewares)
--public/
-```
+Then visit [http://localhost:3000/](http://localhost:3000/)
 
 ## Tests
 
@@ -60,12 +43,5 @@ $ npm test
 ```
 
 ## License
-(The MIT License)
-
-Copyright (c) 2012 Madhusudhan Srinivasa < [[email protected]](mailto:[email protected]) >
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT