Update README and add CHANGELOG #93
Conversation
| - [`syncReduxAndRouter(history, store, selectRouterState?)`](#syncreduxandrouter) | ||
| - [`routeReducer`](#routereducer) | ||
| - [`UPDATE_PATH`](#update-path) | ||
| - [`updatePath(pathname, noRouterUpdate)`](#updatepath) |
| redux state and keeps it in sync with any react-router changes. | ||
| Additionally, you can change the URL via redux and react-router will | ||
| change accordingly. | ||
| ##### _What about redux-router?_ |
There was a problem hiding this comment.
I think we should move all of this redux-router stuff to the bottom, and focus on the usage and API first and foremost. Might be @jlongster disagrees, though.
There was a problem hiding this comment.
I think it will essentially replace redux-router and that will live as its own standalone project. -- #80
based on the above, it seems like rackt is moving away from redux-router, so this section probably won't be around for much longer... but since many people are already using redux-router, it might a good idea to leave this for the time being
There was a problem hiding this comment.
maybe adding a migration guide or example would be a good idea
migrating from redux-router? use this commit as a reference
| ### Breaking | ||
|
|
||
| The `updatePath(path, noRouterUpdate)` action creator has been removed in favor of | ||
| `pushPath(path, state, avoidRouterUpdate)` and `replacePath(path, state, avoidRouterUpdate)` |
There was a problem hiding this comment.
Maybe:
The
updatePathaction creator has been removed in favor ofpushPathandreplacePath(#38)
Other breaking changes:
- We have added support for routing
state(Handle routing state and replace #38) - Our actions are now FSA compliant (use FSA actions #63)
Other:
- Redux DevTools should now work as expected (Get devtools working #73)
- As we no longer depend on
window.location,<base href="...">should now work (<base href="..."> ignored #62) - We've done lots of work on finding the right way to stop cycles, so hopefully we shouldn't have any unnecessary location or store updates (Stopping cycles #50)
|
@jlongster Got time to take a look? Would be nice to get 1.0 out. |
| @@ -1,75 +1,62 @@ | |||
| # [redux-simple-router](#docs) | |||
There was a problem hiding this comment.
This link doesn't work right now.
(And I can't remember seeing other's link like this in the main headline, so I'm not sure we should do it. Maybe just remove the link? If it's too far down to the documentation, it just means we should remove some of the text above it)
|
Thanks a lot, this looks good. I think I'm going to remove the table of contents though. Half the links are already broken probably because we changed headers. |
Update README and add CHANGELOG
|
Just pushed 1.0.0. |
|
🎉 |
|
Thanks so much for your hard work friends, I'm really enjoying working with this library! |
Resolves #84
👉 Preview updated README
Clean up README and update syntax for #89