From f4e8fe820f16b6694f6fcb22e98e1d20abfa7ed4 Mon Sep 17 00:00:00 2001 From: Pia Date: Mon, 22 Jan 2024 13:31:40 +0800 Subject: [PATCH] update readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cbce30..3176001 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,19 @@ [![Cargo Test](https://github.com/HerodotusDev/rust-mmr/actions/workflows/ci.yml/badge.svg)](https://github.com/HerodotusDev/rust-mmr/actions/workflows/ci.yml) +# Quick Start + +Add dependency on `Cargo.toml` + +# Development + +Test : `cargo test --all-features` +Bench : `cargo bench --all-features` + +```rust +accumulators = { version = "0.4.0", features = ["all"] } +``` + ## Accumulators ### - [MMR](./src/mmr/README.md) @@ -53,4 +66,4 @@ Key value stores used for storing the accumulator data. --- -Herodotus Dev Ltd - 2023 +Herodotus Dev Ltd - 2024