Document a bit the heed and heed3 crates differences

README.md

@@ -1,17 +1,17 @@
 <p align="center"><img width="280px" src="https://raw.githubusercontent.com/meilisearch/heed/main/assets/heed-pigeon-logo.png"></a></p>
-<h1 align="center" >heed</h1>
+<h1 align="center" >heed & heed3</h1>
 
 [![License](https://img.shields.io/badge/license-MIT-green)](#LICENSE)
 [![Crates.io](https://img.shields.io/crates/v/heed)](https://crates.io/crates/heed)
 [![Docs](https://docs.rs/heed/badge.svg)](https://docs.rs/heed)
 [![dependency status](https://deps.rs/repo/github/meilisearch/heed/status.svg)](https://deps.rs/repo/github/meilisearch/heed)
 [![Build](https://github.com/meilisearch/heed/actions/workflows/rust.yml/badge.svg)](https://github.com/meilisearch/heed/actions/workflows/rust.yml)
 
-A Rust-centric [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database) abstraction with minimal overhead. This library enables the storage of various Rust types within LMDB, extending support to include Serde-compatible types.
+A Rust-centric [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database) abstraction with minimal overhead. This library enables the storage of various Rust types within LMDB, extending support to include Serde-compatible types. It not only supports the LMDB `mdb.master` branch but also the `mdb.master3` branch which features encryption-at-rest and checksumming.
 
 ## Simple Example Usage
 
-Here is an example on how to store and read entries into LMDB in a safe and ACID way. For usage examples, see [heed/examples/](heed/examples/). To see more advanced usage techniques go check our [Cookbook](https://docs.rs/heed/latest/heed/cookbook/index.html).
+Here is an example on how to store and read entries into LMDB in a safe and ACID way. For usage examples, see [examples/](examples/). To see more advanced usage techniques go check our [Cookbook](https://docs.rs/heed/latest/heed/cookbook/index.html).
 
 ```rust
 use std::fs;

heed/src/envs/env_open_options.rs

@@ -161,7 +161,7 @@ impl EnvOpenOptions {
     }
 
     /// Creates a blank new set of options ready for configuration and specifies that
-    /// the [`Env`] will be encrypted using the `E` algorithm with the given `key`.
+    /// the [`Env`] will be encrypted-at-rest using the `E` algorithm with the given `key`.
     ///
     /// You can find more compatible algorithms on [the RustCrypto/AEADs page](https://github.com/RustCrypto/AEADs#crates).
     ///

heed/src/lib.rs

@@ -5,9 +5,16 @@
     html_logo_url = "https://raw.githubusercontent.com/meilisearch/heed/main/assets/heed-pigeon-logo.png?raw=true"
 )]
 
-//! `heed` is a high-level wrapper of [LMDB].
+//! `heed` and `heed3` are high-level wrappers of [LMDB].
 //!
-//! The [cookbook] will give you a variety of complete Rust programs to use with heed.
+//! - `heed` is a wrapper around LMDB on the `mdb.master` branch,
+//! - `heed3` derives from the `heed` wrapper but on the `mdb.master3` branch.
+//!
+//! The `heed3` crate will be stable once the LMDB version on the `mdb.master3` branch
+//! will be officially released. It features encryption-at-rest and checksumming features
+//! that the `heed` crate doesn't.
+//!
+//! The [cookbook] will give you a variety of complete Rust programs to use with `heed`.
 //!
 //! ----
 //!

lmdb-master3-sys/README.md

@@ -1,3 +1,3 @@
-# lmdb-master-sys
+# lmdb-master3-sys
 
-Rust bindings for liblmdb on the mdb.master branch.
+Rust bindings for liblmdb on the mdb.master3 branch.