Skip to content

Commit 189e1df

Browse files
committed
Update README.md
Readme file updated.
1 parent 97db317 commit 189e1df

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Features
1111
* All files related to a conceptual unit are placed together. For example, the controller, HTML, LESS, and unit test for a template are placed together in the same directory.
1212
* Provides a ready-made Grunt build that produces an extremely optimized distribution.
1313
* Build uses [grunt-ngmin](https://github.com/btford/grunt-ngmin) so you don't have to use the Angular injection syntax for safe minification (i.e. you dont need `$inject` or `(['$scope','$http',...`.
14-
* `grunt serve` task allows you to run a simple development server with watch/livereload enabled. Additionally, JSHint and the appropriate unit tests are run for the changed files.
14+
* `grunt run` task allows you to run a simple development server with watch/livereload enabled. Additionally, JSHint and the appropriate unit tests are run for the changed files.
1515
* Integrates Bower for package management
1616
* Includes Yeoman subgenerators for directives, services, templates, controllers, filters, and modules.
1717
* Integrates LESS and includes Bootstrap via the source LESS files allowing you to reuse Bootstrap vars/mixins/etc.
18-
* Easily Testable - Each sub-generator creates a skeleton unit test. Unit tests can be run via `grunt test` and they run automatically during the grunt watch that is active during `grunt serve`.
18+
* Easily Testable - Each sub-generator creates a skeleton unit test. Unit tests can be run via `grunt test` and they run automatically during the grunt watch that is active during `grunt run`.
1919

2020
Directory Layout
2121
-------------
@@ -84,11 +84,12 @@ Grunt Tasks
8484

8585
Now that the project is created, you have 3 simple Grunt commands available:
8686

87-
grunt serve #This will run a development server with watch & livereload enabled.
87+
grunt run #This will run a development server with watch & livereload enabled.
8888
grunt test #Run local unit tests.
89+
grunt e2e #Run protractor end to end(e2e) tests.
8990
grunt build #Places a fully optimized (minified, concatenated, and more) in /dist
9091

91-
When `grunt serve` is running, any changed javascript files will be linted using JSHint as well as have their appropriate unit tests executed. Only the unit tests that correspond to the changed file will be run. This allows for an efficient test driven workflow.
92+
When `grunt run` is running, any changed javascript files will be linted using JSHint as well as have their appropriate unit tests executed. Only the unit tests that correspond to the changed file will be run. This allows for an efficient test driven workflow.
9293

9394
Yeoman Subgenerators
9495
-------------
@@ -104,15 +105,15 @@ There are generators for `directive`, `template`, `service`, `filter`, `module`,
104105

105106
Running a generator:
106107

107-
yo ng-appgen:directive my-awesome-directive
108+
yo ng-appgen:directive my-directive
108109
yo ng-appgen:template my-template
109110
yo ng-appgen:service my-service
110111
yo ng-appgen:service my-controller
111112
yo ng-appgen:filter my-filter
112113
yo ng-appgen:module my-module
113114
yo ng-appgen:modal my-modal
114115

115-
The name paramater passed (i.e. 'my-awesome-directive') will be used as the file names. The generators will derive appropriate class names from this parameter (ex. 'my-awesome-directive' will convert to a class name of 'MyAwesomeDirective'). Each sub-generator will ask for the folder in which to create the new skeleton files. You may override the default folder for each sub-generator in the `.yo-rc.json` file.
116+
The name paramater passed (i.e. 'my-directive') will be used as the file names. The generators will derive appropriate class names from this parameter (ex. 'my-awesome-directive' will convert to a class name of 'MyAwesomeDirective'). Each sub-generator will ask for the folder in which to create the new skeleton files. You may override the default folder for each sub-generator in the `.yo-rc.json` file.
116117

117118
The modal subgenerator is a convenient shortcut to create templates that work as modals for Bootstrap v3.1 and Angular-UI-Bootstrap v0.10 (both come preconfigured with this generator). If you choose not to use either of these libraries, simply don't use the modal subgenerator.
118119

@@ -126,7 +127,7 @@ Submodules allow you to more explicitly separate parts of your application. Use
126127
Preconfigured Libraries
127128
-------------
128129

129-
The new app will have a handful of preconfigured libraries included. This includes Angular 1.2, Bootstrap 3, AngularUI Bootstrap, AngularUI Utils, FontAwesome 4, JQuery 2, Underscore 1.5, LESS 1.6, and Moment 2.5. You may of course add to or remove any of these libraries. But the work to integrate them into the app and into the build process has already been done for you.
130+
The new app will have a handful of preconfigured libraries included. This includes Angular 1.3, Bootstrap 3, AngularUI Bootstrap, AngularUI Utils, FontAwesome 4, JQuery 2, Underscore 1.5, LESS 1.6, and Moment 2.5. You may of course add to or remove any of these libraries. But the work to integrate them into the app and into the build process has already been done for you.
130131

131132
Build Process
132133
-------------

0 commit comments

Comments
 (0)