changed Readme file

Author: moizKachwala

README.md

@@ -8,14 +8,19 @@
 
 ##Introduction
 
-Basic Angular seed application created with Quick start application given on angular website. It uses Express server along with Mongo DB support (Mongoose) via a wrapper of Repository Pattern as Business layer.
-It also uses Gulp for copying our resources.
+Basic Angular seed application created with Quick start application (Tour of Heroes) given on angular website. It uses ExpressJS along with Mongo DB support (Mongoose) via a wrapper of Repository Pattern as Business layer.
+It also uses Gulp for running task and TsLint.The seed application is built over node and uses latest node packages.
+
+## Prerequisites
+
+1. Latest version of Node to be installed.
+2. Install MongoDB and make sure it is running on default port 27017 (if not then please configure constants.ts and change the connection for mongoDB).
 
 ## Steps to Run
 ```sh
-    npm install
-    npm build
-    npm start
+    npm install      <= install all the npm Dependencies
+    npm build        <= build client and server application.
+    npm start        <= start the Nodemon and watch for changes.
 ```
 
 ## Directory Structure
@@ -104,7 +109,7 @@ angular2-MEAN
 
 1. Angular 2 Quick Start application (Tours of Hero) from https://angular.io/docs/ts/latest/quickstart.html
 2. Added support for Gulp so that js files are moved out of the app folder.
-3. It will create a build folder where it will place all the js files.
+3. It will create a dist folder where it will place all the js files.
 4. Gulp will monitor for the changes via help of watcher.
 5. Created folder structure for easy access of components, services and models.
 6. Applied tslint for avoiding any typos.
@@ -113,6 +118,14 @@ angular2-MEAN
 9. Added MongoDB support to communicate our Heroes data to Database
 10.Implemented Repository Pattern to communicate with Mongoose.
 
+## Api Document (from MongoDB)
+
+1. getAll    http://localhost:3000/api/heroes             <= get all heroes
+1. getById   http://localhost:3000/api/heroes/:id         <= get hero by Id
+2. post      http://localhost:3000/api/heroes             <= create hero
+2. put       http://localhost:3000/api/heroes/:id         <= update hero
+2. delete    http://localhost:3000/api/heroes/:id         <= delete hero
+
 ## Dependencies
 
 1. Angular 2
@@ -124,9 +137,7 @@ angular2-MEAN
 7. TsLint
 8. MongoDB
 
+## License
 
-## UpComming
-
-Presenlty mongoDB has been added but still need to wire up the heroes services to the DB.
-
+MIT