From 1ed44d189249aef306ab886c7ac368928a795347 Mon Sep 17 00:00:00 2001 From: Varunkumar Nagarajan Date: Tue, 11 Oct 2022 09:02:19 +0530 Subject: [PATCH 1/2] Update README with breaking changes in 4.x --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 46a929d..82b5da4 100644 --- a/README.md +++ b/README.md @@ -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 benchmark runs can be found 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. From 154ff3b74fc8f703ee5a10b861665a2dc844216d Mon Sep 17 00:00:00 2001 From: Varunkumar Nagarajan Date: Tue, 11 Oct 2022 09:03:49 +0530 Subject: [PATCH 2/2] Format breaking changes section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 82b5da4..2d96147 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ 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 benchmark runs can be found 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. +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