modified README

This commit is contained in:
jose 2021-10-06 12:39:27 +02:00
parent 54847b37fd
commit bffa5e7952
1 changed files with 10 additions and 1 deletions

View File

@ -1,4 +1,13 @@
#circomlibjs
Javascript library to work with circomlib circuits
`circomlibjs` is a Javascript library that provides programs to compute the witness of several circuits of `circomlib`.
This library is used to make tests of circomlib circuits.
In the src directory the package includes these programs, in the
test directory includes its own tests and, in the tools directory includes programs to precompute some needed parameters.
You can install `circomlibjs` with the following command:
```text
npm install -g circomlibjs
```