diff --git a/README.md b/README.md index 58c43bc..996f51e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # IBLT -Invertible bloom lookup table implementation in rust. +An Invertible Bloom Lookup Table implementation in the Rust programming language. -`IBLT` uses bincode for serialization/deserialization of key and values, so both key and value type must implement `Serialize` and `Deserialize`. If two serialized values have different length, zero padding is added at the end of shorter value for xor operation. +`IBLT` uses bincode for serialization/deserialization of key and values, so both key and value type must implement `Serialize` and `Deserialize`. If two serialized values have different lengths, zero padding is added at the end of the shorter value for xor operation. -Hash function can be specified by creating `IBLT` with `with_hasher` function. Hash value for `hash_sum` is calculated as `hash(val)`, and index is calculated as `hash(hash(val)), hash(hash(hash(val))), ...`. If hasher is not specified, `DefaultHasher` from `std::collections::hash_map` is used. +A hash function can be specified by creating an `IBLT` with the `with_hasher` function. The hash value for `hash_sum` is calculated as `hash(val)`, and the index is calculated as `hash(hash(val)), hash(hash(hash(val))), ...`. If the hasher is not specified, `DefaultHasher` from `std::collections::hash_map` is used. ## Example ```rust