Skip to content

Update README with breaking changes in 4.x #39

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.

Sign up for GitHub

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

Merged
joseph-fox merged 2 commits into from
Oct 11, 2022
Merged

Update README with breaking changes in 4.x #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ed44d1
Update README with breaking changes in 4.x
varunkumar Oct 11, 2022
154ff3b
Format breaking changes section
varunkumar Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ link followed by "Download Zip."

Similar steps are possible under linux and MacOS X.

# Breaking changes with 4.x
Support for non-cryptographic hashes has been added in 4.0.0. For 128 bit hashes, md5 has been replaced with xxh3_128, one of the [fastest](https://github.com/Cyan4973/xxHash) non-cryptographic hash functions. Details of the benchmark runs can be found [here](https://github.com/joseph-fox/python-bloomfilter/pull/38). Files generated with earlier versions of the module *will not work* with this version. Consider re-generating them using the latest version optimized for speed.

# Installation verification
Type `pip show pybloom-live` from a command prompt. Version should be
2.2.0 as of 2016-12-11.