diff --git a/README.md b/README.md index a9d07911b7..5d87101093 100644 --- a/README.md +++ b/README.md @@ -231,6 +231,34 @@ Route({handler: App}, Paths are not inherited from parent routes. +### Link (Component) + +Creates an anchor tag that links to a route in the application. Also +gets the `active` class automatically when the route matches. If you +change the path of your route, you don't have to change your links. + +#### Properties + +**to** - The name of the route to link to. + +**query** - Object, Query parameters to add to the link. Access query +parameters in your route handler with `this.props.query`. + +**[param]** - Any parameters the route defines are passed by name +through the link's properties. + +#### Example + +Given a route like ``: + +```xml +{user.name} + +Michael +Michael +``` + ### Handlers There are some properties and hooks available to the handlers you pass @@ -299,31 +327,6 @@ var Settings = React.createClass({ }); ``` -### Link (Component) - -Creates an anchor tag that links to a route in the application. Also -gets the `active` class automatically when the route matches. If you -change the path of your route, you don't have to change your links. - -#### Properties - -**to** - The name of the route to link to. - -**[param]** - Any parameters the route defines are passed by name -through the link's properties. - -#### Example - -Given a route like ``: - -```xml -{user.name} - -Michael -Michael -``` - Development -----------