From 5afde405afc60631eefdbe03dfd816972059e4c2 Mon Sep 17 00:00:00 2001 From: Omar Desogus Date: Wed, 19 Jan 2022 13:00:20 +0100 Subject: [PATCH] docs: add list of dev tech of the project Former-commit-id: 6abb89336c3495da9393a299b9bd0d55eb27bbc0 [formerly 56edf10baaeaece6b2eef8b12fa4e5ba1ee583c4] [formerly 2d85c1dc9ce060265243a82d365c78243da6ca53 [formerly ff6d439a0b8168e2cb3429ce0ab2ff4a28b7b0d4]] Former-commit-id: c090dcd261b24b7f1756fef218ee637f9d9bebb7 [formerly 6ef0dadbb5249eddeb1c0a5fdfc6b5bf4c6ffcb8] Former-commit-id: 4ef9de747e4fd88a022192d6180dc3f332ec375f --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 99b506d..9d06701 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- ZK-kit + 🧰 ZK-kit

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

@@ -39,9 +39,16 @@ -ZK-kit 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. -🟢 ZK-kit uses [Conventional Commits](https://www.conventionalcommits.org) (`yarn commit`). + +| ZK-kit 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. | +| ------------------------------------------------------------------------------------------------------------------------------------ | + +♚ Simplified package management with [Lerna](https://lerna.js.org/) (`yarn`, `yarn build`, `yarn publish:fp`)\ +♛ [Conventional Commits](https://www.conventionalcommits.org) for adding human and machine readable meaning to commit messages (`yarn commit`)\ +♜ [Jest](https://jestjs.io/) tests & common test coverage for all packages (`yarn test`)\ +♞ [ESLint](https://eslint.org/) & [Prettier](https://prettier.io/) to keep the code neat and well organized (`yarn prettier` & `yarn lint`)\ +♝ Simple benchmarking framework for JavaScript/TypeScript libraries with [Benny](https://github.com/caderek/benny) (`yarn benchmark`) ---