Skip to content

Commit c1d2487

Browse files
authored
chore: Update README.md (#19)
1 parent b5f64e5 commit c1d2487

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@
1616
1717
## Features
1818
- Supernova NIVC folding scheme implementation
19-
- Support for both Noir and Circom circuit frameworks
20-
- Client-side proving capabilities through native ARM & WebAssembly
21-
- Recursive proof generation and verification
19+
- Support for Noir circuit DSL
20+
- Client-side proving capabilities through native x86, aarch64, and WASM
21+
- End-to-end proof setup, running, and verification
2222

2323
## Project Structure
2424
The repository contains several key components:
2525
- `edge-prover`: Backend implementation of Supernova NIVC folding scheme
2626
- `edge-frontend`: Frontend adapters for Noir to use `edge-prover`
2727
- `demo`: A demo application for the `edge-frontend` and `edge-prover`
28+
- `nivc`: A Noir package to use with the NIVC folding scheme
2829

2930
### Prerequisites
3031
Before running the demo, ensure you have:
@@ -83,9 +84,21 @@ ERROR demo: ❌ Proof verification failed: NovaError
8384
Error: NovaError(ProofVerifyError)
8485
```
8586

86-
8787
## Usage
88-
This repository and its crates are **not** production ready. Do not use them in production. No audits have been done and none are planned.
88+
You can use the `edge-frontend` crate to use the NIVC folding scheme for your own Noir programs. In your `Cargo.toml`, add the following:
89+
```
90+
[dependencies]
91+
edge-frontend = { git = "https://github.com/pluto/edge", branch = "main" }
92+
```
93+
and then add the following to your `Nargo.toml`:
94+
```
95+
[dependencies]
96+
nivc = { tag = "v0.1.0", git = "https://github.com/pluto/edge" }
97+
```
98+
The `edge-frontend` assumes that the structure provided by the `nivc` crate is used. Please see the `demo` crate for an example of how to use the `edge-frontend` with the `nivc` crate and the `examples` directory for examples of Noir programs that use the `nivc` crate inside of other tests (see `frontend/tests/nivc/`).
99+
100+
> [!WARNING]
101+
> This repository and its crates are **not** production ready. Do not use them in production. No audits have been done and none are planned.
89102
90103
With that said, work has been done to make the implementation here work with an offline setup phase. Therefore, this can be used run proofs on an edge device which can later be verified by a remote server.
91104

@@ -103,4 +116,4 @@ This project is licensed under the Apache V2 License - see the [LICENSE](LICENSE
103116

104117
## Acknowledgements
105118
> [!NOTE]
106-
> This repository is a fork of the original hosted at [https://github.com/microsoft/nova](https://github.com/microsoft/nova) and also forked from [https://github.com/argumentcomputer/arecibo](https://github.com/argumentcomputer/arecibo).
119+
> This repository is a fork of the original hosted at [https://github.com/microsoft/nova](https://github.com/microsoft/nova) and also forked from [https://github.com/argumentcomputer/arecibo](https://github.com/argumentcomputer/arecibo).

0 commit comments

Comments
 (0)