forked from angular/router
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(*): Updated README.md for clarity
- Loading branch information
1 parent
85cb2f0
commit c4caa98
Showing
1 changed file
with
7 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,11 @@ | ||
| # The New Angular Router | ||
| [](https://travis-ci.org/angular/router) | ||
| # Deprecated / Defunct / Non-working | ||
|
|
||
| A work-in-progress new router for Angular 1.3 and 2.0, written with | ||
| [AtScript](https://docs.google.com/document/d/11YUzC-1d0V1-Q3V0fQ7KSit97HnZoKVygDxpWzEYW0U/). | ||
| This repository used to contain a version of the router, which is now deprecated. | ||
|
|
||
| If you are interested in the recommended component router, please look in the Angular 2 | ||
| repository at https://github.com/angular/angular/tree/master/modules/%40angular/router | ||
|
|
||
| ## State of this project | ||
| # About this branch | ||
|
|
||
| Currently, the router is usable in Angular 1, but still missing many of the planned features. | ||
| APIs will rapidly change, so I do not recommend using this in an important production app quite yet. | ||
|
|
||
| See the [Progress Document](https://docs.google.com/document/d/1-DBXTHaeec6XH5qx2tKVrgrjiILy76_lSrjgJv95RJ4/edit#) | ||
| for standup-style updates | ||
|
|
||
| ### Trying the router | ||
|
|
||
| You can install the router via `npm`: | ||
|
|
||
| ```shell | ||
| npm install angular-new-router | ||
| ``` | ||
|
|
||
| The documentation is pretty sparse. See the `examples/` directory in this repo for now. | ||
|
|
||
| ### Helping out | ||
|
|
||
| For now, the best way for you to help with the new router is to try it out and file GitHub issues | ||
| with questions or feedback. Please also [check out existing discussions](https://github.com/angular/router/labels/type%3A%20use%20case). | ||
|
|
||
| ## Goals | ||
|
|
||
| This router aims to fulfill the requirements mentioned in the [Angular 2.0 router design document](https://docs.google.com/document/d/1I3UC0RrgCh9CKrLxeE4sxwmNSBl3oSXQGt9g3KZnTJI). | ||
|
|
||
| Below is a short summary of these goals: | ||
|
|
||
| * Have sensible conventions and defaults | ||
| * Be customizable at almost every point | ||
| * Support sibling "viewports" (like `ng-view`s in Angular 1.x's ngRoute) | ||
| * Support nested routers | ||
| * Allow components to encapsulate entire parts of an application | ||
| * Expose a "navigation model" which can be used to generate a navigation UI (like menus) | ||
| * Expose which route in the model is active (useful in styling/highlighting links in the menu) | ||
| * Generate `href`s based on router hierarchies | ||
| * Lazy-load components | ||
| * Be able to reuse component instances | ||
| * Use either push state or hash change mode | ||
| * Handle updating the document title | ||
|
|
||
|
|
||
| ## Prior Art | ||
|
|
||
| * [Durandal Router](http://durandaljs.com/documentation/Using-The-Router.html) | ||
| * [ngRoute from Angular 1.x](https://docs.angularjs.org/api/ngRoute) | ||
| * [Route Recognizer](https://github.com/tildeio/route-recognizer) | ||
|
|
||
|
|
||
|
|
||
| ## License | ||
| Apache 2 | ||
| This branch is necessary because of the ambigouity of the v0.5.3.1 (branch vs. tag). | ||
| **Do not delete.** |