Skip to content

Commit 8e13055

Browse files
committed
Updated readme
1 parent 720f41f commit 8e13055

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
# Install
1+
## Install
22
`meteor add reactrouter:react-router-ssr`
33

4-
# Usage
5-
## `ReactRouterSSR.Run(routes, [clientOptions], [serverOptions])`
4+
## Usage
5+
### `ReactRouterSSR.Run(routes, [clientOptions], [serverOptions])`
66
The `routes` argument takes the routes you want react-router to use (you don't have to call `React.render()` yourself)<br />
77
Read the [react-router documentation](http://rackt.github.io/react-router/tags/v1.0.0-beta3.html) for more informations.
88

9-
### clientOptions
10-
The additional arguments you would like to give to the `<Router />` component on the client. <br />
9+
#### routes
10+
Your main `<Route />` node of your application.
1111

12-
### serverOptions
13-
The additional arguments you would like to give to the `<Router />` component on the server. <br />
12+
#### clientOptions (optional)
13+
The additional arguments you would like to give to the `<Router />` component on the client.
1414

15-
# Example
15+
#### serverOptions (optional)
16+
The additional arguments you would like to give to the `<Router />` component on the server.
17+
18+
## Example
1619
```javascript
1720
const {Route} = ReactRouter;
1821

@@ -44,5 +47,5 @@ if (Meteor.isClient) {
4447
}
4548
```
4649

47-
# Warning
50+
## Warning
4851
This is using react-router 1.0 even though it is still in beta. The API is stable and working very well in production.

0 commit comments

Comments
 (0)