Docs + fix benchmarks (#16)

Author: alrevuelta

README.md

@@ -5,17 +5,20 @@
 ![GitHub License](https://img.shields.io/github/license/bilinearlabs/rs-merkle-tree?style=flat-square)
 [![Join our Discord](https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white&style=flat-square)](https://discord.gg/Et8BTnVBZS)
 
-Merkle tree implementation in Rust with configurable storage backends and hash functions. This Merkle tree implementation features:
+Merkle tree implementation in Rust with the following features:
 * Fixed depth: All proofs have a constant size equal to the `Depth`.
 * Append-only: Leaves are added sequentially starting at index `0`. Once added, a leaf cannot be modified.
 * Optimized for Merkle proof retrieval: Intermediate leaves are stored so that Merkle proofs can be fetched from memory without needing to be calculated lazily, resulting in very fast retrieval times.
+* Configurable storage backends to store the bottom and intermediate leaves up the root.
+* Configurable hash functions to hash nodes.
+* Simple and easy to use interface: `add_leaves`, `root`, `num_leaves`, `proof`.
 
 
 Add `rs-merkle-tree` as a dependency to your Rust `Cargo.toml`.
 
 ```toml
 [dependencies]
-rs-merkle-tree = { git = "https://github.com/bilinearlabs/rs-merkle-tree.git" }
+rs-merkle-tree = "0.1.0"
 ```
 
 You can create a Merkle tree, add leaves, get the number of leaves and get the Merkle proof of a given index as follows. This creates a simple merkle tree using keccak256 hashing algorithm, a memory storage and a depth 32.
@@ -37,19 +40,60 @@ fn main() {
 }
 ```
 
-You can customize your tree by choosing a different store, hash function, and depth as follows. This tree also uses keccak256 but persists the leaves in a key-value sled store and has a depth of 32.
+You can customize your tree by choosing a different store, hash function, and depth as follows. Note that you have to modify the `feature` for the stores. This avoids importing the stuff you don't need. See the following examples.
+
+**Depth: 32 | Hashing: Keccak | Store: sled**
+
+```toml
+[dependencies]
+rs-merkle-tree = { version = "0.1.0", features = ["sled_store"] }
+```
 
 ```rust
-use rs_merkle_tree::store::SledStore;
-use rs_merkle_tree::tree::MerkleTree;
 use rs_merkle_tree::hasher::Keccak256Hasher;
+use rs_merkle_tree::stores::SledStore;
+use rs_merkle_tree::tree::MerkleTree;
 
 fn main() {
     let mut tree: MerkleTree<Keccak256Hasher, SledStore, 32> =
         MerkleTree::new(Keccak256Hasher, SledStore::new("sled.db", true));
 }
 ```
 
+**Depth: 32 | Hashing: Poseidon | Store: rocksdb**
+```toml
+rs-merkle-tree = { version = "0.1.0", features = ["rocksdb_store"] }
+```
+
+```rust
+use rs_merkle_tree::hasher::PoseidonHasher;
+use rs_merkle_tree::stores::RocksDbStore;
+use rs_merkle_tree::tree::MerkleTree;
+
+fn main() {
+    let mut tree: MerkleTree<PoseidonHasher, RocksDbStore, 32> =
+        MerkleTree::new(PoseidonHasher, RocksDbStore::new("rocksdb.db"));
+}
+
+```
+
+**Depth: 32 | Hashing: Poseidon | Store: sqlite**
+
+```toml
+rs-merkle-tree = { version = "0.1.0", features = ["sqlite_store"] }
+```
+
+```rust
+use rs_merkle_tree::hasher::PoseidonHasher;
+use rs_merkle_tree::stores::SqliteStore;
+use rs_merkle_tree::tree::MerkleTree;
+
+fn main() {
+    let mut tree: MerkleTree<PoseidonHasher, SqliteStore, 32> =
+        MerkleTree::new(PoseidonHasher, SqliteStore::new("tree.db"));
+}
+```
+
 ## Stores
 
 The following stores are supported:
@@ -65,7 +109,7 @@ The following hash functions are supported:
 
 ## Benchmarks
 
-The following benchmarks measure in a MacBook Pro the following:
+The following benchmarks measure in a AMD Ryzen 7 7700 8-Core Processor with 64GB of RAM the following:
 * Consumed disk size
 * Leaf insertion throughput in thousands per second.
 * Merkle proof generation times.
@@ -92,19 +136,19 @@ python benchmarks.py
 
 | Depth | Hash | Store | Throughput (Kelem/s) |
 |---|---|---|---|
-| 32 | keccak256 | sqlite | 9.203 |
-| 32 | keccak256 | rocksdb | 11.315 |
-| 32 | keccak256 | sled | 38.518 |
-| 32 | keccak256 | memory | 88.117 |
+| 32 | keccak256 | rocksdb | 18.280 |
+| 32 | keccak256 | sqlite | 22.348 |
+| 32 | keccak256 | sled | 43.280 |
+| 32 | keccak256 | memory | 86.084 |
 
 ### `proof` time
 
 | Depth | Hash | Store | Time |
 |---|---|---|---|
-| 32 | keccak256 | memory | 880.810 ns |
-| 32 | keccak256 | sled | 8.613 µs |
-| 32 | keccak256 | rocksdb | 64.176 µs |
-| 32 | keccak256 | sqlite | 92.422 µs |
+| 32 | keccak256 | memory | 560.990 ns |
+| 32 | keccak256 | sled | 7.878 µs |
+| 32 | keccak256 | sqlite | 14.562 µs |
+| 32 | keccak256 | rocksdb | 34.391 µs |
 
 ## License