docs(readme): Updated docs to reflect new version

Author: DaftMonk

readme.md

@@ -1,14 +1,23 @@
 # AngularJS + Express Full Stack Generator 
 
-A generator for AngularJS, integrated with an Express `server.js` for full stack development. 
+A MEAN stack generator for Yeoman, Angular Fullstack scaffolds applications with MongoDB, Express, AngularJS, Node, and a lot of customization.
 
 Featuring: 
 
  * Express server integrated with grunt tasks
  * Livereload of client and server files
+ * Support for Jade and CoffeeScript
  * Easy deployment workflow.
- * Optional mongoDB integration
- * Support for jade templates
+ * MongoDB integration
+ * Passport integration for adding user accounts
+
+## Example project
+
+Generated by saying yes to all questions: http://fullstack-demo.herokuapp.com/. 
+
+> Note: Demo is running on heroku free instance, so you will likely have to refresh for it to load.
+
+Have a look at the source code: https://github.com/DaftMonk/fullstack-demo
 
 ## Usage
 
@@ -27,14 +36,14 @@ Run `yo angular-fullstack`, optionally passing an app name:
 yo angular-fullstack [app-name]
 ```
 
-### Express
+## Express
 
 Launch your express server in development mode.
 ```
 grunt serve
 ``` 
 
-Launch your express server in production mode, uses the minified/optimized production app folder.
+Launch your express server in production mode, uses the minified/optimized production folder.
 ```
 grunt serve:dist
 ``` 
@@ -43,11 +52,23 @@ grunt serve:dist
 
 `grunt serve` will watch client files in `app/`, and server files inside `lib/`, restarting the Express server when a change is detected.
 
-### Deployment
+## Deployment
+
+To generate a dist folder that can easily be deployed use:
+
+    grunt
 
-While deployment should be easy enough with the `grunt dist` build, we provide an extremely simplifed deployment process for heroku.
+This will run unit tests, jshint, concatenate and minify scripts/css, compress images, add css vendor prefixes, and finally copy all files to a tidy dist folder.
 
-`yo angular-fullstack:deploy heroku` for generating a deployment ready folder for [heroku.com](http://heroku.com/) from your project files. 
+Alternatively to skip tests and jshint, use:
+
+    grunt build
+
+### Heroku Deployment
+
+We provide an extremely simplifed deployment process for heroku.
+
+`yo angular-fullstack:deploy heroku` generates a `dist` folder that is deployment ready  for [heroku.com](http://heroku.com/). 
 
 **Create and Deploy an app in 4 steps**
 
@@ -57,173 +78,56 @@ While deployment should be easy enough with the `grunt dist` build, we provide a
 
 3. `yo angular-fullstack:deploy heroku`
 
-4. `cd heroku && git push heroku master`
+4. `cd dist && git push heroku master`
 
 5. Optional (if using mongoDB) `heroku addons:add mongohq`
 
 That's it! Your app should be live and shareable. Type `heroku open` to view it.  
 
 ## Generators
 
-Available generators:
-
-* [angular-fullstack](#app) (aka [angular-fullstack:app](#app))
-* [angular-fullstack:controller](#controller)
-* [angular-fullstack:directive](#directive)
-* [angular-fullstack:filter](#filter)
-* [angular-fullstack:route](#route)
-* [angular-fullstack:service](#service)
-* [angular-fullstack:provider](#service)
-* [angular-fullstack:factory](#service)
-* [angular-fullstack:value](#service)
-* [angular-fullstack:constant](#service)
-* [angular-fullstack:decorator](#decorator)
-* [angular-fullstack:view](#view)
-* [angular-fullstack:deploy](#deploy)
-
-**Note: Generators are to be run from the root directory of your app.**
-
-### App
-Sets up a new AngularJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Twitter Bootstrap and additional AngularJS modules, such as angular-resource (installed by default).
-
-Example:
-```bash
-yo angular-fullstack
-```
-
-### Deploy
-Initalizes a heroku app and generates a `heroku` folder which is ready to push to heroku.
-
-Example:
-```bash
-yo angular-fullstack:deploy heroku
-```
-
-After app modifications run:
-```bash
-grunt heroku
-```
-then commit and push the heroku folder.
-
-### Route
-Generates a controller and view, and configures a route in `app/scripts/app.js` connecting them.
-
-Example:
-```bash
-yo angular-fullstack:route myroute
-```
-
-Produces `app/scripts/controllers/myroute.js`:
-```javascript
-angular.module('myMod').controller('MyrouteCtrl', function ($scope) {
-  // ...
-});
-```
-
-Produces `app/views/myroute.html`:
-```html
-<p>This is the myroute view</p>
-```
-
-### Controller
-Generates a controller in `app/scripts/controllers`.
-
-Example:
-```bash
-yo angular-fullstack:controller user
-```
-
-Produces `app/scripts/controllers/user.js`:
-```javascript
-angular.module('myMod').controller('UserCtrl', function ($scope) {
-  // ...
-});
-```
-### Directive
-Generates a directive in `app/scripts/directives`.
+Available Angular generators:
 
-Example:
-```bash
-yo angular-fullstack:directive myDirective
-```
+* [angular-fullstack](#app) (aka [angular-fullstack:app](https://github.com/yeoman/generator-angular#app))
+* [angular-fullstack:controller](https://github.com/yeoman/generator-angular#controller)
+* [angular-fullstack:directive](https://github.com/yeoman/generator-angular#directive)
+* [angular-fullstack:filter](https://github.com/yeoman/generator-angular#filter)
+* [angular-fullstack:route](https://github.com/yeoman/generator-angular#route)
+* [angular-fullstack:service](https://github.com/yeoman/generator-angular#service)
+* [angular-fullstack:provider](https://github.com/yeoman/generator-angular#service)
+* [angular-fullstack:factory](https://github.com/yeoman/generator-angular#service)
+* [angular-fullstack:value](https://github.com/yeoman/generator-angular#service)
+* [angular-fullstack:constant](https://github.com/yeoman/generator-angular#service)
+* [angular-fullstack:decorator](https://github.com/yeoman/generator-angular#decorator)
+* [angular-fullstack:view](https://github.com/yeoman/generator-angular#view)
 
-Produces `app/scripts/directives/myDirective.js`:
-```javascript
-angular.module('myMod').directive('myDirective', function () {
-  return {
-    template: '<div></div>',
-    restrict: 'E',
-    link: function postLink(scope, element, attrs) {
-      element.text('this is the myDirective directive');
-    }
-  };
-});
-```
+Available Fullstack generators:
 
-### Filter
-Generates a filter in `app/scripts/filters`.
+* [angular-fullstack:deploy](#deploy)
 
-Example:
-```bash
-yo angular-fullstack:filter myFilter
-```
+**Note: Generators are to be run from the root directory of your app.**
 
-Produces `app/scripts/filters/myFilter.js`:
-```javascript
-angular.module('myMod').filter('myFilter', function () {
-  return function (input) {
-    return 'myFilter filter:' + input;
-  };
-});
-```
+All of the **generator-angular** client side generators are available, but aliased using `angular-fullstack`. 
 
-### View
-Generates an HTML view file in `app/views`.
+They are aliased to ensure the files they generate are added to the correct folders and that the `index.(html/jade)` is updated properly. 
 
-Example:
-```bash
-yo angular-fullstack:view user
-```
+Read more on them from the offical [generator angular documentation][1] 
 
-Produces `app/views/user.html`:
-```html
-<p>This is the user view</p>
-```
+## Fullstack specfic generators
 
-### Service
-Generates an AngularJS service.
+### Deploy
+Initalizes a heroku app and generates a `dist` folder which is ready to push to heroku.
 
 Example:
 ```bash
-yo angular-fullstack:service myService
-```
-
-Produces `app/scripts/services/myService.js`:
-```javascript
-angular.module('myMod').service('myService', function () {
-  // ...
-});
+yo angular-fullstack:deploy heroku
 ```
 
-You can also do `yo angular-fullstack:factory`, `yo angular-fullstack:provider`, `yo angular-fullstack:value`, and `yo angular-fullstack:constant` for other types of services.
-
-### Decorator
-Generates an AngularJS service decorator.
-
-Example:
+After app modifications run:
 ```bash
-yo angular-fullstack:decorator serviceName
-```
-
-Produces `app/scripts/decorators/serviceNameDecorator.js`:
-```javascript
-angular.module('myMod').config(function ($provide) {
-    $provide.decorator('serviceName', function ($delegate) {
-      // ...
-      return $delegate;
-    });
-  });
+grunt build
 ```
+then commit and push the dist folder.
 
 ## Options
 In general, these options can be applied to any generator, though they only affect generators that produce scripts.
@@ -256,52 +160,18 @@ angular.module('myMod')
 
 A project can mix CoffeScript and JavaScript files.
 
-To output JavaScript files, even if CoffeeScript files exist (the default is to output CoffeeScript files if 
-the generator finds any in the project), use `--coffee=false`.
+To output JavaScript files, even if CoffeeScript files exist (the default is to output CoffeeScript files if the generator finds any in the project), use `--coffee=false`.
 
 ### Minification Safe
 
 **Deprecated**
 
-[Related Issue #452](https://github.com/yeoman/generator-angular/issues/452): This option is being removed in future versions of the generator. Initially it was needed as ngMin was not entirely stable. As it has matured, the need to keep separate versions of the script templates has led to extra complexity and maintenance of the generator. By removing these extra burdens, new features and bug fixes should be easier to implement. If you are dependent on this option, please take a look at ngMin and seriously consider implementing it in your own code. It will help reduce the amount of typing you have to do (and look through) as well as make your code cleaner to look at.
-
-By default, generators produce unannotated code. Without annotations, AngularJS's DI system will break when minified. Typically, these annotations that make minification safe are added automatically at build-time, after application files are concatenated, but before they are minified. By providing the `--minsafe` option, the code generated will out-of-the-box be ready for minification. The trade-off is between amount of boilerplate, and build process complexity.
-
-#### Example
-```bash
-yo angular-fullstack:controller user --minsafe
-```
-
-Produces `app/controller/user.js`:
-```javascript
-angular.module('myMod').controller('UserCtrl', ['$scope', function ($scope) {
-  // ...
-}]);
-```
-
-#### Background
-Unannotated:
-```javascript
-angular.module('myMod').controller('MyCtrl', function ($scope, $http, myService) {
-  // ...
-});
-```
-
-Annotated:
-```javascript
-angular.module('myMod').controller('MyCtrl',
-  ['$scope', '$http', 'myService', function ($scope, $http, myService) {
-
-    // ...
-  }]);
-```
-
-The annotations are important because minified code will rename variables, making it impossible for AngularJS to infer module names based solely on function parameters.
+[Related Issue #452](https://github.com/yeoman/generator-angular/issues/452): This option is being removed in future versions of the generator.
 
-The recommended build process uses `ngmin`, a tool that automatically adds these annotations. However, if you'd rather not use `ngmin`, you have to add these annotations manually yourself.
+By default, generators produce unannotated code. Without annotations, AngularJS's DI system will break when minified. [ngMin](https://github.com/btford/ngmin) is used to add these annotations before minification.
 
 ### Add to Index
-By default, new scripts are added to the index.html file. However, this may not always be suitable. Some use cases:
+By default, new scripts are added to the index file. However, this may not always be suitable. Some use cases:
 
 * Manually added to the file
 * Auto-added by a 3rd party plugin
@@ -330,23 +200,6 @@ The following additional modules are available as components on bower, and insta
 
 All of these can be updated with `bower update` as new versions of AngularJS are released.
 
-## Configuration
-Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.
-
-### Output
-You can change the `app` directory by adding a `appPath` property to `bower.json`. For instance, if you wanted to easily integrate with Express.js, you could add the following:
-
-```json
-{
-  "name": "yo-test",
-  "version": "0.0.0",
-  ...
-  "appPath": "public"
-}
-
-```
-This will cause Yeoman-generated client-side files to be placed in `public`.
-
 ## Testing
 
 Running `grunt test` will run the unit tests with karma.
@@ -359,10 +212,9 @@ When submitting an issue, please follow the [guidelines](https://github.com/yeom
 
 When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).
 
-When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
-
-When submitting a new feature, add tests that cover the feature.
-
 ## License
 
 [BSD license](http://opensource.org/licenses/bsd-license.php)
+
+
+  [1]: https://github.com/yeoman/generator-angular#generators