Skip to content

Commit 8430152

Browse files
committed
metadata & readme
1 parent bc2c66c commit 8430152

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

Nargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "keccak256"
33
type = "lib"
4-
authors = ["jtriley-eth"]
4+
authors = ["noir-lang"]
55
compiler_version = ">=0.36.0"
66

77
[dependencies]

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,27 @@
22

33
This package contains the Keccak256 hashing interface, formerly in the Noir standard library.
44

5-
> WIP
5+
## Noir Version Compatibility
6+
7+
This library is tested to work as of Noir v0.36.0.
8+
9+
## Benchmarks
10+
11+
Benchmarks are ignored by `git` and checked on pull-request. As such, benchmarks may be generated
12+
with the following command.
13+
14+
```bash
15+
# execute the following
16+
./scripts/build-gates-report.sh
17+
```
18+
19+
The benchmark will be generated at `./gates_report.json`.
20+
21+
## Installation
22+
23+
In `Nargo.toml`, add the version of this library desired to install the dependency:
24+
25+
```toml
26+
[dependencies]
27+
keccak256 = { tag = "v0.1.0", git = "https://github.com/noir-lang/keccak256" }
28+
```

0 commit comments

Comments
 (0)