From 37bb2ecc5fdb2ca1bcc382f6ded9d4d39dc1959c Mon Sep 17 00:00:00 2001 From: cedoor Date: Thu, 20 Jan 2022 13:28:43 +0100 Subject: [PATCH] docs: improve faq description Former-commit-id: 87adcc4d8fd7e789d1824b3502cf0ad948b1e3a1 [formerly 271dad87044e5223428a020eedc49cddd5f004a4] [formerly 55146a5293b0c4d59d4e1c5bb99c0bbfffca2f5c [formerly 1f71052387b0a24367f5ec4aa194c1482190526f]] Former-commit-id: aa823561f3d8f706af5d6da61030c8ecb390e0ee [formerly 986c7a3bbce97a1e2c6045fd0a20cb41d6b15373] Former-commit-id: 7ef30d82a1dd6fd6ae4986c00fa0b36bb7d89b45 --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 10fa38c..b0b8c44 100644 --- a/README.md +++ b/README.md @@ -43,10 +43,8 @@ - - | 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`)\ @@ -206,9 +204,7 @@ grep -r -l "sparse-merkle-tree" . | xargs sed -i 's/sparse-merkle-tree/my-packag #### How can I test and publish my library? -ZK-kit provides two commands: `yarn test` and `yarn publish:fp`. Both must be run from the root folder. `yarn test` will test all packages in the monorepo, including yours using the files inside your `packages/my-package/tests` folder. `yarn publish:fp` can only be run by those who own the NPM token of the ZK-kit organization. They will then have to publish the package. - -> This task will be automated in the future. +ZK-kit provides two commands: `yarn test` and `yarn publish:fp`. Both must be run from the root folder. `yarn test` will test all packages in the monorepo, including yours using the files inside your `packages/my-package/tests` folder. `yarn publish:fp` can only be run by those who own the NPM token of the ZK-kit organization. They will then have to publish the package. This task will be automated in the future. #### How can I create benchmarks for my library?