Files
zk-kit/README.md
2022-01-14 17:17:21 +01:00

4.8 KiB

ZKit

A monorepo of reusable JS libraries for zero-knowledge techologies.

Github license GitHub Workflow test Linter eslint Code style prettier Lerna

ZKit is a set of NPM modules (algorithms or utility functions) that can be reused in different projects and zero-knowledge protocols, making it easier for developers to access ready-to-use and tested libraries for common tasks.


📦 Packages

Package Version Downloads Size
@zkit/identity NPM version Downloads npm bundle size (scoped)
@zkit/protocols NPM version Downloads npm bundle size (scoped)
@zkit/types NPM version Downloads

🛠 Install

Clone this repository and install the dependencies:

$ git clone https://github.com/appliedzkp/zkit.git
$ cd zkit && npm i

📜 Usage

$ npm run lint # Lint all packages.
$ npm run test # Test all packages (with common coverage).
$ npm run build # Create a JS build for each package.
$ npm run publish:fp # Publish packages on npm.

You can see the other npm scripts in the package.json file.