Skip to content

chore(readme): Add Noir version compatibility, Benchmarks todo and Installation descriptions #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Savio-Sou wants to merge 4 commits into
base: main
Choose a base branch
from
Open

chore(readme): Add Noir version compatibility, Benchmarks todo and Installation descriptions #19

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cb2916
chore(readme): Add Noir version compatibility, Benchmarks todo and In…
Savio-Sou Dec 19, 2024
16c7fcc
Rearrange wording
Savio-Sou Dec 19, 2024
88b2dc3
Update minimum version to v1.0.0-beta.0
Savio-Sou Feb 20, 2025
ca96deb
Merge branch 'main' into ss/readme
kashbrti Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,20 @@ Uses lookup tables and maximally efficient representations of group operations (
Cost of 1 scalar mul = 2232 gates. Marginal cost of additional muls in an msm = 972 gates.

For example usage see `test.nr`

## Noir version compatibility

This library is tested with all Noir stable releases from v1.0.0-beta.0.

## Benchmarks

TODO

## Installation

In your _Nargo.toml_ file, add the version of this library you would like to install under dependency:

```toml
[dependencies]
LIBRARY = { tag = "v0.1.0", git = "https://github.com/noir-lang/noir-edwards" }
```