Skip to content

Commit a9e323d

Browse files
committed
Update README.md
1 parent 3bc4d4f commit a9e323d

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,10 @@
22

33
# UI-Router
44

5-
**Attention**: UI-Router uses <code>grunt >= 0.4.x</code> make sure to upgrade your environment and read the
6-
[Migration Guide](http://gruntjs.com/upgrading-from-0.3-to-0.4).
7-
8-
Finally a de-facto solution to nested views and routing.
9-
5+
####Finally a de-facto solution to nested views and routing.
106

117
## Main Goal
12-
To evolve the concept of an Angular "Route" into a more general concept of a "State" for managing complex application UI states.
8+
To evolve the concept of an [angularjs](http://angularjs.org/) [***route***](http://docs.angularjs.org/api/ng.$routeProvider) into a more general concept of a ***state*** for managing complex application UI states.
139

1410
## Main Features
1511
1. **Robust State Management**
@@ -43,18 +39,23 @@ To evolve the concept of an Angular "Route" into a more general concept of a "St
4339
* [FAQ](https://github.com/angular-ui/ui-router/wiki/Frequently-Asked-Questions)
4440
* [Sample App](http://angular-ui.github.com/ui-router/sample/) ([Source](https://github.com/angular-ui/ui-router/tree/master/sample))
4541
* [Generated Docs](http://angular-ui.github.com/ui-router/build/doc/)
46-
* Latest build: [angular-ui-states.min.js](http://angular-ui.github.com/ui-router/build/angular-ui-states.min.js)
47-
(uncompressed [angular-ui-states.js](http://angular-ui.github.com/ui-router/build/angular-ui-states.js))
42+
* Latest build: [angular-ui-states.min.js](http://angular-ui.github.io/ui-router/release/angular-ui-router.min.js)
43+
(uncompressed [angular-ui-states.js](http://angular-ui.github.io/ui-router/release/angular-ui-router.js))
4844

4945
## Quick Start
50-
1. Add angular-ui-states.min.js to your index.html
51-
>
46+
1. Get ui-router:
47+
>* with bower: `bower install angular-ui-router`
48+
>* fork this repo
49+
>* download the latest build ([compressed](http://angular-ui.github.io/ui-router/release/angular-ui-router.min.js) | [uncompressed](http://angular-ui.github.io/ui-router/release/angular-ui-router.js))
50+
51+
1. Add angular-ui-router.js to your index.html
52+
>
5253
```html
5354
<!doctype html>
5455
<html ng-app="myapp">
5556
<head>
5657
<script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.0.6/angular.min.js"></script>
57-
<script src="angular-ui-states.js"></script>
58+
<script src="angular-ui-router.js"></script>
5859
```
5960

6061
2. Add one or more `ui-view` to your app, give them names.
@@ -124,6 +125,9 @@ myapp.config(function($stateProvider, $routeProvider){
124125
125126
## Developing
126127

128+
**Attention**: UI-Router uses <code>grunt >= 0.4.x</code> make sure to upgrade your environment and read the
129+
[Migration Guide](http://gruntjs.com/upgrading-from-0.3-to-0.4).
130+
127131
Dependencies for building the solution and running tests:
128132

129133
* [grunt-cli](https://github.com/gruntjs/grunt-cli) - run: `$ npm install -g grunt-cli`

0 commit comments

Comments
 (0)