From 0c1b4faa58ea1c0a513e0505bb1be8ff73368be0 Mon Sep 17 00:00:00 2001 From: Dmitriy Ryajov Date: Mon, 20 Mar 2023 22:12:01 -0600 Subject: [PATCH] updating readme --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index abce1d5..7be033b 100644 --- a/README.md +++ b/README.md @@ -18,22 +18,24 @@ or at your option. These files may not be copied, modified, or distributed except according to those terms. ## Usage -First -``` + +First, clone the repo and install the circom components: + +```sh git clone git@github.com:status-im/codex-storage-proofs.git cd codex-storage-proofs npm i cd circuits ``` -Preparing test key material (only suitable for testing) -``` -../scripts/circuit_prep.sh storer 13 +Nex, compile circuits: + +```sh +../scripts/circuit_prep.sh ``` Running the tests: -`npm test` -``` -npm test test/merkletree.js +```sh +cargo test -r # run tests in release mode by default for speed ```