From 94b9b0da6d8344047c78839ac510581c15da4a92 Mon Sep 17 00:00:00 2001 From: Csaba Kiraly Date: Wed, 8 Feb 2023 15:46:17 +0100 Subject: [PATCH] adding minimal README Signed-off-by: Csaba Kiraly --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 92144c0..ad29c15 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,29 @@ [![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) + +WIP Zero Knowledge tooling for the Codex project + +## License + +Licensed and distributed under either of + +* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT + +or + +* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0) + +at your option. These files may not be copied, modified, or distributed except according to those terms. + +## Usage + +Preparing test key material (only suitable for testing) +``` +../scripts/circuit_prep.sh storer 13 +``` + +Running part of the code +``` +npm test test/merkletree.js +``` \ No newline at end of file