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

Commit 987e80a

Browse files
committed
update CHANGELOG and README
1 parent 41e6c57 commit 987e80a

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

CHANGELOG.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11

2-
## HEAD
2+
## [2.0.1](https://github.com/jlongster/redux-simple-router/compare/1.0.2...2.0.1)
33

4-
* New API that uses middleware to trap history calls for a better
5-
unidirectional data flow. New docs and updates coming soon (#141)
4+
**A whole new API, with many breaking changes:**
5+
6+
* `syncReduxAndRouter` is gone. Instead, call `syncHistory` with just the `history` object, which returns a middleware that you need to apply. (#141)
7+
* If you use redux devtools, you need to call `middleware.listenForReplays(store)` on the middleware returned from `syncHistory`. Create the store first with the middleware, then call this function with the store.
8+
* Action creators are now contained in a single object called `routeActions`. `go`, `goBack`, and `goForward` action creators have been added.
9+
* `UPDATE_PATH` is now `UPDATE_LOCATION`.
10+
* The fully parsed [location object](https://github.com/rackt/history/blob/master/docs/Location.md) is now stored in the state instead of a URL string. To access the path, use `state.routing.location.pathname` instead of `state.routing.path`.
611

712
## [1.0.2](https://github.com/jlongster/redux-simple-router/compare/1.0.1...1.0.2)
813

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ _Have an example to add? Send us a PR!_
122122

123123
### API
124124

125+
**This API is for an unreleased version. To view docs for 1.0.2, [click here](https://github.com/rackt/redux-simple-router/tree/1.0.2#api)**
126+
125127
#### `syncHistory(history: History) => ReduxMiddleware`
126128

127129
Call this to create a middleware that can be applied with Redux's `applyMiddleware` to allow actions to call history methods. The middleware will look for route actions created by `push`, `replace`, etc. and applies them to the history.

0 commit comments

Comments
 (0)