Skip to content
This repository was archived by the owner on Oct 26, 2018. It is now read-only.

Commit 5f2b0b6

Browse files
gaearontimdorr
authored andcommitted
Clarify the goal of this library (#387)
1 parent 160395c commit 5f2b0b6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ But the two libraries don't coordinate. You want to do time travel with your app
1212

1313
This library helps you keep that bit of state in sync with your Redux store. We keep a copy of the current location hidden in state. When you rewind your application state with a tool like [Redux DevTools](https://github.com/gaearon/redux-devtools), that state change is propagated to React Router so it can adjust the component tree accordingly. You can jump around in state, rewinding, replaying, and resetting as much as you'd like, and this library will ensure the two stay in sync at all times.
1414

15+
**This library is not _necessary_ for using Redux together with React Router. You can use the two together just fine without any additional libraries. It is useful if you care about recording, persisting, and replaying user actions, using time travel. If you don't care about these features, just [use Redux and React Router directly](http://stackoverflow.com/questions/36722584/how-to-sync-redux-state-and-url-hash-tag-params/36749963#36749963).**
16+
1517
## Installation
1618

1719
```

0 commit comments

Comments
 (0)