Set default unstable version and update readme.md (#55)

Signed-off-by: Karthik Subbarao <[email protected]>

Author: KarthikSubbarao

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "valkey-bloom"
 authors = ["Karthik Subbarao"]
-version = "0.1.0-dev"
+version = "99.99.99-dev"
 edition = "2021"
 license = "BSD-3-Clause"
 repository = "https://github.com/valkey-io/valkey-bloom"

QUICK_START.md

@@ -1,58 +1,58 @@
 # Quick Start
- 
+
 Follow these steps to set up, build, and run the Valkey server with the valkey-bloom module. This guide will walk you through creating a bloom filter, inserting items, and checking for items in the filters.
- 
+
 ## Step 1: Install Valkey and valkey-bloom
- 
+
 1. Build Valkey from source by following the instructions [here](https://github.com/valkey-io/valkey?tab=readme-ov-file#building-valkey-using-makefile). Make sure to use Valkey version 8.0 or above.
- 
+
 2. Build the valkey-bloom module from source by following the instructions [here](https://github.com/valkey-io/valkey-bloom/blob/unstable/README.md#build-instructions).
- 
+
 ## Step 2: Run the Valkey Server with valkey-bloom
- 
+
 Once valkey-bloom is built, run the Valkey server with the module loaded:
- 
+
 In case of Linux:
 ```bash
 ./valkey-server --loadmodule ./target/release/libvalkey_bloom.so
 ```
- 
+
 You should see the Valkey server start, and it will be ready to accept commands.
- 
+
 ## Step 3: Create a Bloom Filter
- 
+
 Start a Valkey CLI session:
- 
+
 ```bash
 valkey-cli
 ```
- 
+
 Create a bloom filter using the BF.ADD, BF.INSERT, BF.RESERVE or BF.MADD commands. For example:
- 
+
 ```bash
 BF.ADD filter-key item-val
 ```
- 
+
 - `filter-key` is the name of the bloom filter we will be operating on
 - `item-val` is the item we are inserting into the bloom filter
- 
+
 ## Step 4: Insert some more items
- 
+
 To insert items on an already created filter, use the `BF.ADD`, `BF.MADD` or `BF.INSERT` commands:
- 
+
 ```bash
 BF.ADD filter-key example 
 BF.MADD filter-key example1 example2 
 ```
- 
+
 Replace the example with the actual items you want to add.
- 
+
 ## Step 5: Check if items are present
- 
+
 Now that you've created a bloom filter and inserted items, you can check what items have been added. Use the `BF.EXISTS` or `BF.MEXISTS` commands to check for items:
- 
+
 ```bash
 BF.EXISTS filter-key example
 ```
- 
-This command checks if an item is present in a bloom filter. Bloom filters can have false positives, but no false negatives. This means that if the BF.EXISTS command returns 0, then the item is not present. But if the BF.EXISTS command returns 1 then there is a possibility (determined by false positive rate) that the item is not actually present.
+
+This command checks if an item is present in a bloom filter. Bloom filters can have false positives, but no false negatives. This means that if the BF.EXISTS command returns 0, then the item is not present. But if the BF.EXISTS command returns 1, there is a possibility (determined by false positive rate) that the item is not actually present.

README.md

@@ -1,10 +1,10 @@
 # valkey-bloom
 
-Valkey-Bloom (BSD-3-Clause) is a Rust Valkey-Module which brings a native and space efficient probabilistic Module data type to Valkey. With this, users can create filters (space-efficient probabilistic Module data type) to add elements, perform “check” operation to test whether an element exists, auto scale their filters, perform RDB Save and load operations, etc.
+Valkey-Bloom (BSD-3-Clause) is a Rust based Valkey-Module which brings a Bloom Filter (Module) data type into Valkey and supports verions >= 8.0. With this, users can create bloom filters (space efficient probabilistic data structures) to add elements, perform “check” operation to test whether an element exists, auto scale their filters, customize bloom filter properties, perform RDB Save and load operations, etc.
 
 Valkey-Bloom is built using `bloomfilter::Bloom` (https://crates.io/crates/bloomfilter which has a BSD-2-Clause license).
 
-It is compatible with the BloomFilter (BF.*) command APIs in Redis offerings.
+It is API compatible with the bloom filter command syntax of the official Valkey client libraries including valkey-py, valkey-java, valkey-go (as well as the equivalent Redis libraries)
 
 ## Supported commands
 ```

src/lib.rs

@@ -13,7 +13,7 @@ use crate::bloom::utils::valid_server_version;
 use valkey_module_macros::info_command_handler;
 
 pub const MODULE_NAME: &str = "bf";
-pub const MODULE_VERSION: i32 = 000000;
+pub const MODULE_VERSION: i32 = 999999;
 // The release stage is used in order to provide release status information.
 // In unstable branch the status is always "dev".
 // During release process the status will be set to rc1,rc2...rcN.