Skip to content

Commit e232b44

Browse files
authored
docs: upade install section in docs (#72)
<!-- Please refer to our CONTRIBUTING documentation for any questions on submitting a pull request. --> <!-- Provide a general summary of your changes in the Title above. --> ## Description <!-- Describe your changes in detail. --> <!-- You may want to answer some of the following questions: --> <!-- What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) --> <!-- What is the current behavior?** (You can also link to an open issue here) --> <!-- What is the new behavior (if this is a feature change)? --> <!-- Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) --> This PR updates the install section in the LeanIMT docs. ## Checklist <!-- Please check if the PR fulfills these requirements. --> - [x] I have read and understand the [contributor guidelines](https://github.com/privacy-scaling-explorations/zk-kit.rust/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/privacy-scaling-explorations/zk-kit.rust/blob/main/CODE_OF_CONDUCT.md). - [x] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [x] My changes generate no new warnings - [ ] I have run `yarn style` without getting any errors - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes > [!IMPORTANT] > We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical mistake, please feel free to message the team.
1 parent 3ac5483 commit e232b44

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

crates/lean-imt/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ The LeanIMT is an optimized binary version of the [IMT](https://github.com/priva
2828

2929
## 🛠 Install
3030

31-
Add the `zk-kit-lean-imt` crate to your `cargo.toml`:
31+
Install the `zk-kit-lean-imt` crate with `cargo`:
3232

33-
```toml
34-
zk-kit-lean-imt = { git = "https://github.com/privacy-scaling-explorations/zk-kit.rust", package = "zk-kit-lean-imt" }
33+
```commandline
34+
cargo add zk-kit-lean-imt
3535
```
3636

3737
## 📜 Usage
3838

3939
```rust
40+
use lean_imt::hashed_tree::{HashedLeanIMT, LeanIMTHasher};
4041
use std::collections::hash_map::DefaultHasher;
4142
use std::hash::{Hash, Hasher};
42-
use zk_kit_lean_imt::hashed_tree::{HashedLeanIMT, LeanIMTHasher};
4343

4444
// Setup hasher
4545
struct SampleHasher;

crates/lean-imt/src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
//!
55
//! ## Quick Start
66
//!
7-
//! Add the crate to your Cargo.toml:
7+
//! Install the `zk-kit-lean-imt` crate with `cargo`:
88
//!
9-
//! ```toml
10-
//! zk-kit-lean-imt = { git = "https://github.com/privacy-scaling-explorations/zk-kit.rust", package = "zk-kit-lean-imt" }
9+
//! ```commandline
10+
//! cargo add zk-kit-lean-imt
1111
//! ```
1212
//!
1313
//! ## Example

0 commit comments

Comments
 (0)