added usage

This commit is contained in:
psippl 2022-03-06 19:23:42 +01:00
parent 6fc71ab357
commit 43d564448c
1 changed files with 7 additions and 0 deletions

View File

@ -2,6 +2,13 @@
Rust support library for using [semaphore](https://github.com/appliedzkp/semaphore). It's mostly a Rust rewrite of [zk-kit](https://github.com/appliedzkp/zk-kit), but just focuses on semaphore (for now) and still covers a much smaller scope. It's using [ark-circom](https://github.com/gakonst/ark-circom) under the hood for generating the groth16 proofs.
## Usage
Add this line to your `cargo.toml`:
```
semaphore = { git = "https://github.com/worldcoin/semaphore-rs" }
```
## Building semaphore circuits
1. Check out submodule (if not done before already): `git submodule update --init --recursive`