migrated router doc

Author: ryanflorence

doc/02 Components/0 Router.md

@@ -1,14 +1,17 @@
 ## Table of Contents
 
-- [Introduction](Introduction.md)
-- [Route Configuration](RouteConfiguration.md)
-- [Route Matching](RouteMatching.md)
-- [Dynamic Routing](DynamicRouting.md)
-- [Confirming Navigation](ConfirmingNavigation.md)
-- [Server Rendering](Server Rendering.md)
 - [Glossary](Glossary.md)
-- [Route](Route.md)
-- [Plain Route](Plain Route.md)
-- [Redirect](Redirect.md)
+- Guides
+  - [Introduction](Introduction.md)
+  - [Route Configuration](RouteConfiguration.md)
+  - [Route Matching](RouteMatching.md)
+  - [Dynamic Routing](DynamicRouting.md)
+  - [Confirming Navigation](ConfirmingNavigation.md)
+  - [Server Rendering](Server Rendering.md)
+- API
+  - [Router](Route.md)
+  - [Route](Route.md)
+  - [Plain Route](Plain Route.md)
+  - [Redirect](Redirect.md)
 
 - [Server Rendering](ServerRendering.md)

docs/README.md

@@ -0,0 +1,73 @@
+Primary component of React Router. It keeps your UI and the URL in sync.
+
+## Props
+-----
+
+#### `children` (required)
+
+One or many [`Routes`][Route] or [Plain Routes][PlainRoute]. When the
+history changes, `Router` will match a branch of its [`Routes`][Route],
+and render their configured [components][RouteComponent], with child
+route components nested inside the parents.
+
+#### `routes`
+
+Alias for `children`.
+
+#### `history`
+
+The history the router should listen to from the `history` package.
+
+#### `createElement(Component, props)`
+
+When the router is ready to render a branch of route components, it will
+use this function to create the elements. You may want to take control
+of creating the elements when you're using some sort of data
+abstraction, like setting up subscriptions to stores, or passing in some
+sort of application module to each component via props.
+
+##### Examples
+
+```js
+<Router createElement={createElement}/>
+
+// default behavior
+function createElement(Component, props) {
+  // make sure you pass all the props in!
+  return <Component {...props}/>
+}
+
+// maybe you're using something like Relay
+function createElement(Component, props) {
+  // make sure you pass all the props in!
+  return <RelayContainer Component={Component} routerProps={props}/>;
+}
+```
+
+#### `stringifyQuery(queryObject)`
+
+A function used to convert an object from `Link`s or calls to
+`transitionTo` to a URL query string.
+
+#### `parseQueryString(queryString)`
+
+A function used to convert a query string into an object that gets
+passed to route component props.
+
+#### `onError(error)`
+
+While the router is matching, errors may bubble up, here
+is your opportunity to catch and deal with them. Typically these will
+come from async features like `route.getComponents` and
+`route.getChildRoutes`.
+
+### `onUpdate()`
+
+Called whenever the router updates its state in response to URL changes.
+
+Examples
+--------
+
+Please see the `examples/` directory of the repository for extensive
+exampls of using `Router`.
+

docs/Router.md

@@ -13,7 +13,7 @@ const { func, object } = React.PropTypes;
  * it needs each time the URL changes.
  */
 const Router = React.createClass({
-  
+
   propTypes: {
     history: object,
     children: routes,