Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(version): update README to reflect correct version #757

Closed
wants to merge 1 commit into from

Conversation

floroz
Copy link

@floroz floroz commented Oct 24, 2021

Thank you for much for your amazing work on this library and your contribution to the whole community.

I have used redux-observable years ago and really appreciated the hard work you have put into it.
I am recently jumping on a new project that uses the library and quickly realised that v2.0.0 has been released but the docs (and the main README.md) is not reflecting that, causing a bit of confusion.

I have updated the main README to reflect the correct version, rxjs's version and the library's peer dependency.

As soon as I familiarise myself with the changes introduces in v2, I am happy to contribute upgrading the rest of the documentation.

> Note: current stable version `redux-observable` doesn't work with `rxjs@7.x.x`, it works with `rxjs@6.x.x`. If you still want to use `rxjs@7.x.x`, upgrade to `redux-observable@2.0.0-rc.2`.
### RxJS version compatibility

Current stable version `redux-observable@2.0.0` is compatible with `rxjs@7.0.0`. If your project is using `rxjs@6.x.x`, and you cannot upgrade, we recommend downgrading to (`redux-observable@1.x.x`).
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have taken the liberty to add this, but please let me know if could be incorrect/misleading.

@jayphelps
Copy link
Member

Appreciate the help with this! Apologies that it's no longer applicable.

@jayphelps jayphelps closed this Apr 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants