kylefang/react-native-routy
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-routy.git synced 2026-01-12 16:42:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Zhigang Fang
2016-10-21 15:17:31 +08:00
parent 7c672b0e58
commit 8c2669c5e0
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,3 +1,4 @@
React Native Routy
--------
@@ -24,13 +25,12 @@ npm install --save react-native-routy
#### Reducer
```javascript
import {reducer as routyReducer} from 'routy'
import {reducer as routyReducer} from 'react-native-routy'
export default combineReducers({
//... other routes here
routes: routyReducer([{page: 'Home'}]) // `[{page: 'Home'}]` is your initial route
})
```
> by default, you should mount this reducer in `routes` of your root reducer, but you customize this too.
@@ -39,7 +39,7 @@ export default combineReducers({
#### Component
```javascript
import {Route} from 'routy'
import {Route} from 'react-native-routy'
<Route
routyMountPoint="routes" // this is optional
@@ -53,7 +53,7 @@ import {Route} from 'routy'
#### Actions
```javascript
import {actions as routyAction} from 'routy'
import {actions as routyAction} from 'react-native-routy'
...
export default connect(null, (dispatch) => ({
pushToEvent: () => dispatch(routyAction.pushRoute({page: 'Events'})),
@@ -70,7 +70,7 @@ This component also support having multiple router instances, here is how:
#### Reducer
```javascript
import {reducer as routyReducer} from 'routy'
import {reducer as routyReducer} from 'react-native-routy'
export default combineReducers({
//... other routes here
@@ -85,7 +85,7 @@ export default combineReducers({
#### Component
```javascript
import {Route} from 'routy'
import {Route} from 'react-native-routy'
<Tab>
<TabItem>
@@ -119,7 +119,7 @@ import {Route} from 'routy'
#### Actions
```javascript
import {actions as routyAction} from 'routy'
import {actions as routyAction} from 'react-native-routy'
...
export default connect(null, (dispatch) => ({
pushToEvent: () => dispatch(routyAction.pushRoute({page: 'Events'}, 'home')),