github/zk-kit
1
1
Fork 0
mirror of https://github.com/privacy-scaling-explorations/zk-kit.git synced 2026-04-22 03:00:15 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve faq description

Browse Source 
Former-commit-id: 87adcc4d8fd7e789d1824b3502cf0ad948b1e3a1 [formerly 271dad87044e5223428a020eedc49cddd5f004a4] [formerly 55146a5293b0c4d59d4e1c5bb99c0bbfffca2f5c [formerly 1f71052387]]
Former-commit-id: aa823561f3d8f706af5d6da61030c8ecb390e0ee [formerly 986c7a3bbce97a1e2c6045fd0a20cb41d6b15373]
Former-commit-id: 7ef30d82a1dd6fd6ae4986c00fa0b36bb7d89b45
This commit is contained in:
cedoor
2022-01-20 13:28:43 +01:00
parent 776d3ed86b
commit 37bb2ecc5f
1 changed files with 2 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -43,10 +43,8 @@
</h4>
</div>
| 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?