Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jtriley2p committed Jan 15, 2025
1 parent 8fd01ae commit 85b2756
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,27 @@

This package contains the SHA256 hashing interface, formerly in the Noir standard library.

> WIP
## Noir Version Compatibility

This library is tested to work as of Noir v0.36.0.

## Benchmarks

Benchmarks are ignored by `git` and checked on pull-request. As such, benchmarks may be generated
with the following command.

```bash
# execute the following
./scripts/build-gates-report.sh
```

The benchmark will be generated at `./gates_report.json`.

## Installation

In `Nargo.toml`, add the version of this library desired to install the dependency:

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

0 comments on commit 85b2756

Please sign in to comment.