From 3a19ebee623ac621fa6cf78f1e1ce28c6f890c2f Mon Sep 17 00:00:00 2001 From: Joshua Trujillo Date: Thu, 16 Jan 2025 21:24:37 +0000 Subject: [PATCH] update readme --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index abd8a11..ee92b59 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,19 @@ Add a brief description of the library ## Noir version compatibility -TODO: Update Noir version numbers tested compatible with - -This library is tested to work as of Noir version 1.0.0-beta.x. +This library is tested to work as of Noir version 0.36.0 & 1.0.0-beta.x. ## Benchmarks -TODO +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