Updated docs

CHANGELOG.MD

@@ -1,6 +1,11 @@
 * 0.1.2
   * added ng template cache support (see #67)
   * configured commons module
+  * enabled HTML5 mode
+  * support for executing a subset of the unit tests (or a specific one)
+  * enhanced TSLint configuration
+  * support for executing unit tests against multiple Web browsers
+  * centralized reports
 * 0.1.1
   * separated base assets and other assets
   * fixed issues with TS helpers

README.md

@@ -8,25 +8,34 @@
 A Webpack Starter kit featuring:
 * AngularJS (setup, angular-material, router, ...)
 * [TypeScript](http://www.typescriptlang.org/)
+  * the future of JavaScript available now
 * [Redux](https://github.com/rackt/redux)
+  * one-way data flow for shared state management
 * [Immutable.js](https://facebook.github.io/immutable-js/)
-* [JSData](http://www.js-data.io/)
 * [RxJS](https://github.com/Reactive-Extensions/RxJS)
 * [Lodash](https://lodash.com/)
-* [SASS](http://sass-lang.com/)
 * [PostCSS](https://github.com/postcss/postcss)
 * [Autoprefixer](https://github.com/postcss/autoprefixer)
 * [Karma](http://karma-runner.github.io/)
+  * unit test runner
 * [Protractor](https://angular.github.io/protractor/#/)
+  * end-to-end test framework/runner
 * [Jasmine](http://jasmine.github.io/)
+  * bdd unit testing library
 * [Istanbul](https://gotwarlost.github.io/istanbul/)
+  * generate code coverage reports
 * [TSLint](https://www.npmjs.com/package/tslint)
+  * check TypeScript code quality/style
 * [Typings](https://github.com/typings/typings)
+  * manage TypeScript type definitions
 * [TSDoc](https://www.npmjs.com/package/tsdoc)
+  * generate API documentation
 * [moment](http://momentjs.com/)
 * [Sinon.JS](http://sinonjs.org/)
+* [SASS](http://sass-lang.com/)
+* [JSData](http://www.js-data.io/)
 
-... and a complete build based on Webpack/npm scripts with:
+A complete build based on Webpack/npm scripts and tons of features:
 * hot module replacement (HMR)
   * https://webpack.github.io/docs/hot-module-replacement-with-webpack.html
   * https://webpack.github.io/docs/hot-module-replacement.html
@@ -41,6 +50,10 @@ A Webpack Starter kit featuring:
 * TS quality/style checks (TSLint)
 * TS code documentation generation (TSDoc)
 * development and production configurations
+  * optimizations for production (minification, compression, ...)
+* security best practices
+  * Content Security Policy (CSP)
+  * ...
 * ...
 
 Check out the [change log](CHANGELOG.MD)
@@ -54,29 +67,23 @@ Note that this starter kit is derived from the Angular 2 Starter Kit: https://gi
 Check out the issues/labels & milestones to get an idea of what's next. For existing features, refer to the previous section.
 
 ## Installation
-...
+First of all, make sure that you have installed NodeJS & npm: https://nodejs.org/en/.
 
-## Upgrade
-Check out the [upgrade](UPGRADE.MD) page
-
-## Frequently Asked Questions (FAQ)
-### Proxy
-If you are behind a corporate proxy, you should ensure that your configuration allows you to work correctly.
+Two approaches:
+* clone this repository: `git clone https://github.com/dsebastien/angularjs-webpack-starter.git`
+* download a zip: https://github.com/dsebastien/angularjs-webpack-starter/archive/master.zip
 
-First, you should be able to configure the `HTTP_PROXY` and `HTTPS_PROXY` in your environment so that all CLI tools (e.g., git, typings, ...) can go through the proxy.
+Now you can download all the necessary dependencies using the setup script: `npm run setup`.
 
-Don't forget to also define the `NO_PROXY` variable to avoid going through the proxy for local resources (e.g., localhost, local domains, etc).
+Finally, you can start the development server using `npm start`.
 
-Note that the .typingsrc file is there to avoid issues caused by SSL termination that is often done in corporate environments. Note that the configuration we provide is INSECURE as it just disables certificate checks. Rather, you should adapt the .typingsrc configuration file so that it continues to check the certificate chain but accepts self-signed certificates generated by your company. Refer to the documentation of typings for more details about the possibilities: https://github.com/typings/typings
+Check out the scripts section below for more information about the available commands.
 
-If the above does not work in your case, then check to make sure that the user agents are allowed through the proxy. Some corporate environments filter Web access to specific user agents (e.g., IE). The following user agents should be allowed through:
-* npm/
-* node/
-* git/
-* typings/
+## Upgrade
+Check out the [upgrade](UPGRADE.MD) page
 
-## Build tasks
-* `npm run setup`: install typings and project dependencies
+## Scripts
+* `npm run setup`: install required global dependencies and project dependencies
 * `npm start`: start the development server
 * `npm run start:hmr`: start the development server with Hot Module Replacement enabled
 * `npm run build:prod`: build the production version (in /dist)
@@ -106,6 +113,22 @@ If the above does not work in your case, then check to make sure that the user a
 * `npm run webdriver:start`: start the Webdriver Manager
 * `npm run webdriver:update`: update Webdriver
 
+## Frequently Asked Questions (FAQ)
+### Proxy
+If you are behind a corporate proxy, you should ensure that your configuration allows you to work correctly.
+
+First, you should be able to configure the `HTTP_PROXY` and `HTTPS_PROXY` in your environment so that all CLI tools (e.g., git, typings, ...) can go through the proxy.
+
+Don't forget to also define the `NO_PROXY` variable to avoid going through the proxy for local resources (e.g., localhost, local domains, etc).
+
+Note that the .typingsrc file is there to avoid issues caused by SSL termination that is often done in corporate environments. Note that the configuration we provide is INSECURE as it just disables certificate checks. Rather, you should adapt the .typingsrc configuration file so that it continues to check the certificate chain but accepts self-signed certificates generated by your company. Refer to the documentation of typings for more details about the possibilities: https://github.com/typings/typings
+
+If the above does not work in your case, then check to make sure that the user agents are allowed through the proxy. Some corporate environments filter Web access to specific user agents (e.g., IE). The following user agents should be allowed through:
+* npm/
+* node/
+* git/
+* typings/
+
 ## Links
 * Code quality rules (tslint)
   * Rules: http://palantir.github.io/tslint/rules/

UPGRADE.MD

@@ -1,5 +1,11 @@
 # Upgrade guide
 
+## From 0.1.1 to 0.1.2
+Wait for it...
+
+## From 0.1.0 to 0.1.1
+Wait for it...
+
 ## From 0.1.0 to 0.1.0
 Wait for it...