Update README.md

README.md

@@ -1,5 +1,50 @@
 # zk-remote-attestation
 
+## Bnechmarking
+All of the experiments are __reproducible on commodity hardware__ using __Linux__-based operating systems. We have provided pre-built executable/binary files in the repository that can be used easily for benchmarking. 
+
+### Setup/Installation
+
+The only preparation that is required to execute benchmarks is installing "node js and snarkjs package" that can be done in any OS easily as follows:
+
+__For Installing Node JS:__
+
+> curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+
+> source ~/.bashrc
+
+> nvm install v16.20.0
+
+__For installing snarkjs:__
+> npm install -g snarkjs
+
+
+### Execution
+1. clone the repository with following command:
+> git clone [email protected]:zero-savvy/zk-remote-attestation.git
+
+2. go to the benchmark directory:
+> cd zk-remote-attestation/benchmarking
+
+3. We have prepared a script for benchmark. Simply give it execution permissions:
+> chmod +x script.sh
+
+4. Run the benchmarks! \
+The script takes two inputs: 1) number of tests, and 2) the test name [choose from "ra10", "ra20", "ra30", and "ra40"].
+
+__Example 1__: running proofs of attestation tree with height of __30__ for __10__ times:
+> ./script.sh 10 ra30
+
+__Example 2__: running proofs of attestation tree with height of __20__ for __5__ times:
+> ./script.sh 5 ra20
+
+__Sample output__: The script reports the average time for generating witness and the proof. Below is a sample output:
+>Average witness generation time: 0.4152 seconds\
+Average proof generation time: 0.7881 seconds
+
+> __NOTE__:\
+> Please note that depending on the system, generating witnesses and proofs can take time. since the generation times are usually consistent, we suggest trying the benchmark with small number of tests (e.g. 5 or 10) before running higher number of tests.
+
 ## References
 [1] [Circom](https://github.com/iden3/circom): For building and compiling ZK circuits.
 
@@ -9,7 +54,5 @@
 
 [4] [Circom-compatible POSEIDON implementation in JavaScript](https://github.com/BigWhaleLabs/poseidon): Shoutout to [@BigWhaleLabs](https://github.com/BigWhaleLabs) for the accurate implementation of POSEIDON that is compatible with CircomLib.
 
-## Acknowledgement
-
 ## License
 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.