### Installation
As usual:
```bash
$ npm i navigator-relay --save
```
Then include it in your code:
```js
import {NavigatorRelay, makeNavState, navigationReducer} from 'navigator-relay';
```
And finally, use it to make your navigation to work:
```jsx
const store = createStore(
  navigationReducer,
  makeNavState([<SomeInitialView/>])
);

AppRegistry.registerComponent('Basic', () => () => (
  <Provider store={store}>
    <NavigatorRedux />
  </Provider>
));
```

**Note:** This implementation use redux for managing a navigation stack.

## API
Each view in the stack, while rendered, will receive a `nav` property with `index`, `stack` and `actions`.
- **index** {Number}. Used to track your navigation stack position
- **stack** {Immutable.Stack}. Your navigation stack
- **actions** {Object}:
  - **push(route)**. Push a new navigation state
  - **pop()**. Jump back to the previous navigation state
  - **replace(route)**. Replace a current navigation state route by a given one

For further reading, [check an example](https://github.com/Kureev/navigator-relay/blob/master/example/Basic/Content.js#L50-L66).

## Status
- [x] Simple navigation
- [ ] Animated transitions