pmtree/README.md

34 lines
649 B
Markdown
Raw Normal View History

2022-10-19 12:18:34 +00:00
<p align="center">
2022-10-30 20:35:36 +00:00
<img src="./pmtree.png" width="150">
</p>
<p align="center">
<img src="https://github.com/Rate-Limiting-Nullifier/pmtree/workflows/Build-Test-Fmt/badge.svg" width="140">
2022-10-19 12:18:34 +00:00
</p>
2022-10-11 17:10:32 +00:00
<h1 align="center">pmtree</h1>
<h3 align="center">Persistent Merkle Tree (optimized & sparse & fixed-size) in Rust</h3>
2022-10-11 17:10:32 +00:00
## How to use
```toml
[dependencies]
pmtree = { git = "https://github.com/Rate-Limiting-Nullifier/pmtree" }
2022-10-11 17:21:26 +00:00
```
## Clone & Build
```bash
git clone git@github.com:Rate-Limiting-Nullifier/pmtree.git && cd pmtree
cargo build --release
```
2022-10-19 12:18:34 +00:00
## Run tests
```bash
cargo test --release
```
2022-10-28 13:54:54 +00:00
## Docs
```bash
cargo docs --open
```