Skip to content

Commit d3094df

Browse files
committed
docs(readme): apply direct reader-facing tone
1 parent 689fe40 commit d3094df

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
</div>
1212

13-
ProveKit takes a Noir circuit, lowers it to R1CS, and proves it with WHIR. Built for mobile and constrained environments ships with a custom BN254 hash engine ([Skyscraper](skyscraper/)), swap-to-disk memory management, and C FFI for iOS and Android. There's also a gnark recursive verifier that wraps WHIR proofs in Groth16 for on-chain verification.
13+
ProveKit lets you take a Noir circuit, compile it to R1CS, and generate a WHIR proof. It's built for mobile and constrained environments and ships with a custom BN254 hash engine ([Skyscraper](skyscraper/)), swap-to-disk memory management, and C FFI for iOS and Android. If you need on-chain verification, there's a gnark recursive verifier that wraps proofs in Groth16.
1414

1515
---
1616

@@ -49,7 +49,7 @@ graph TD
4949

5050
| Layer | Crate | Description |
5151
| :--- | :--- | :--- |
52-
| CLI | `tooling/cli/` | `provekit-cli` prepare, prove, verify, inspect |
52+
| CLI | `tooling/cli/` | `provekit-cli`: prepare, prove, verify, inspect |
5353
| Prover / Verifier | `provekit/prover/`<br>`provekit/verifier/` | WHIR sumcheck, witness solving, commitment |
5454
| Compiler | `provekit/r1cs-compiler/` | Noir ACIR → R1CS with constraint optimizations |
5555
| Hash engine | `skyscraper/` | Custom BN254 hash with SIMD-accelerated field arithmetic |
@@ -59,7 +59,7 @@ graph TD
5959

6060
## Example
6161

62-
[`noir-examples/basic`](./noir-examples/basic/) proves knowledge of a Poseidon hash preimage:
62+
Here's [`noir-examples/basic`](./noir-examples/basic/), which proves knowledge of a Poseidon hash preimage:
6363

6464
```rust
6565
use dep::poseidon2;
@@ -95,7 +95,7 @@ noirup --version v1.0.0-beta.19
9595
<details>
9696
<summary><strong>2. Compile a circuit</strong></summary><br>
9797

98-
Using `poseidon-rounds` as the example:
98+
The steps below use `poseidon-rounds` as the example circuit.
9999

100100
**With nargo:**
101101
```sh
@@ -161,7 +161,7 @@ cargo test -p provekit-bench --bench bench
161161
| [Samply](https://github.com/mstange/samply) | CPU flamegraphs | `samply record -r 10000 -- ./target/release/provekit-cli prove ...` |
162162
| [Instruments](https://crates.io/crates/cargo-instruments) | Allocations (macOS only) | `cargo instruments --template Allocations --release --bin provekit-cli prove ...` |
163163

164-
To inspect without running a proof:
164+
If you want to inspect without running a proof:
165165
```sh
166166
provekit-cli circuit_stats ./target/basic.json # constraint count and R1CS structure
167167
provekit-cli analyze-pkp ./prover.pkp # proving key size breakdown
@@ -172,10 +172,10 @@ provekit-cli show-inputs ./verifier.pkv ./proof.np # public input names and val
172172

173173
## Acknowledgements
174174

175-
- [**WHIR**](https://github.com/WizardOfMenlo/whir) the polynomial commitment scheme and sumcheck protocol the proof system is built on. `WhirR1CSScheme` wraps it for R1CS satisfiability over BN254.
175+
- [**WHIR**](https://github.com/WizardOfMenlo/whir): the polynomial commitment scheme and sumcheck protocol the proof system is built on. `WhirR1CSScheme` wraps it for R1CS satisfiability over BN254.
176176

177-
- [**Spongefish**](https://github.com/arkworks-rs/spongefish) Fiat-Shamir library from arkworks. All transcript construction and challenge derivation goes through its `DuplexSponge` API.
177+
- [**Spongefish**](https://github.com/arkworks-rs/spongefish): Fiat-Shamir library from arkworks. All transcript construction and challenge derivation goes through its `DuplexSponge` API.
178178

179-
- [**gnark-skyscraper**](https://github.com/reilabs/gnark-skyscraper) Go implementation of the Skyscraper hash. The recursive verifier needs it to reproduce the same Merkle commitments as the Rust prover.
179+
- [**gnark-skyscraper**](https://github.com/reilabs/gnark-skyscraper): Go implementation of the Skyscraper hash. The recursive verifier needs it to reproduce the same Merkle commitments as the Rust prover.
180180

181-
- [**Noir**](https://github.com/noir-lang/noir) the ZK DSL we compile from. Write your circuit in Noir, run nargo to get ACIR, and ProveKit handles the rest.
181+
- [**Noir**](https://github.com/noir-lang/noir): the ZK DSL we compile from. Write your circuit in Noir, run nargo to get ACIR, and ProveKit handles the rest.

0 commit comments

Comments
 (0)