Improving README.md

[vicentereig]

@jeme I'd like to level up the docs. Trying to get at least the README.md to a similar level as https://github.com/angular-ui/ui-router#nested-states--views.

My goal is to cover the main use cases in a couple of tutorial-like README:

• [ ] Presenting routes as a mediating controller that bootstraps objects, loads data, and triggers the render loop.
• [ ] Nesting routes.
• [ ] Accessing parameters in the route and query string (such as filtering or paginating params).
• [ ] Impact on the views.

What do you think about it? Am I missing something?

Cheers!

[jeme]

Hello... And thx for the help...

I would rather go in a more clean direction with the Readme, e.g. as with https://github.com/angular/angular.js... but yet not quite that clean... and then push more of all the info into the Github pages which are a work in progress...

E.g. : http://dotjem.github.io/angular-routing/#/tutorial/starting

I am still a bit unsure of what the tutorial should cover, hazard of being so much into the source that I don't would know what would be relevant.

(The source for all the pages are under: https://github.com/dotJEM/angular-routing/tree/master/gh-pages, tuts specifically in this folder: https://github.com/dotJEM/angular-routing/tree/master/gh-pages/templates/tutorials)

Help on those would be more than welcome.. I am quite pressed for time these days... so I really don't get much done.