Updated readme.md

README.md

@@ -1,50 +1,33 @@
-# Addons for Angular UI-Router: Sticky State, Deep State Redirect, Future State
+# Addons for Angular UI-Router:
+# Sticky State, Deep State Redirect, Future State
 
-[TODO - brief summary]
+UI-Router is the defacto router for AngularJS.
+
+UI-Router Extras adds 3 additional features to help you write large modular applications.
+
+Full Website (description, API, demos): http://christopherthielen.github.io/ui-router-extras/
 
-## Demo
-http://christopherthielen.github.io/ui-router-extras/
 
 ## Dependencies
 - required:
-	[TODO]
-- optional
-	[TODO]
-
-See `bower.json` and `index.html` in the `gh-pages` branch for a full list / more details
+    - "angular": "~1.2.0",
+    - "angular-ui-router": "~0.2.10"
 
 ## Install
 1. download the files
 	1. Bower
 		1. add `"ui-router-extras": "latest"` to your `bower.json` file then run `bower install` OR run `bower install ui-router-extras`
 2. include the files in your app
-	1. `er-extras.min.js`
-3. include the module in angular (i.e. in `app.js`) - `christopherthielen.ui-router-extras`
-
-See the `gh-pages` branch, files `bower.json` and `index.html` for a full example.
-
-
-## Documentation
-See the `er-extras.js` file top comments for usage examples and documentation
-https://github.com/christopherthielen/ui-router-extras/blob/master/er-extras.js
-
+	1. `ct-ui-router-extras.min.js`
+3. include the module in angular (i.e. in `app.js`) - `ct.ui.router.extras`
 
 ## Development
 
-1. `git checkout gh-pages`
-	1. run `npm install && bower install`
-	2. write your code then run `grunt`
-	3. git commit your changes
-2. copy over core files (.js and .css/.less for directives) to master branch
-	1. `git checkout master`
-	2. `git checkout gh-pages er-extras.js er-extras.min.js er-extras.less er-extras.css er-extras.min.css`
-3. update README, CHANGELOG, bower.json, and do any other final polishing to prepare for publishing
-	1. git commit changes
-	2. git tag with the version number, i.e. `git tag v1.0.0`
-4. create github repo and push
-	1. [if remote does not already exist or is incorrect] `git remote add origin [github url]`
-	2. `git push origin master --tags` (want to push master branch first so it is the default on github)
-	3. `git checkout gh-pages`
-	4. `git push origin gh-pages`
-5. (optional) register bower component
-	1. `bower register ui-router-extras [git repo url]`
+1. `git checkout master`
+    1. run `npm install && bower install`
+    2. write your code then run `grunt`
+    3. git commit your changes
+
+The Gruntfile.js default target generates the output files into a build/ directory.  It runs all unit tests on
+the built file, as well as the minified file.
+