diff --git a/README.md b/README.md index 67e727c..2956c38 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@

- ZKit + ZK-kit

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

- - Github license + + Github license - - GitHub Workflow test + + GitHub Workflow test Linter eslint @@ -23,7 +23,7 @@

-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. +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. --- @@ -37,70 +37,70 @@ ZKit is a set of NPM modules (algorithms or utility functions) that can be reuse - - @zkit/identity + + @zk-kit/identity - - NPM version + + NPM version - - Downloads + + Downloads - - npm bundle size (scoped) + + npm bundle size (scoped) - - @zkit/protocols + + @zk-kit/protocols - - NPM version + + NPM version - - Downloads + + Downloads - - npm bundle size (scoped) + + npm bundle size (scoped) - - @zkit/types + + @zk-kit/types - - NPM version + + NPM version - - Downloads + + Downloads @@ -115,8 +115,8 @@ ZKit is a set of NPM modules (algorithms or utility functions) that can be reuse Clone this repository and install the dependencies: ```bash -$ git clone https://github.com/appliedzkp/zkit.git -$ cd zkit && npm i +$ git clone https://github.com/appliedzkp/zk-kit.git +$ cd zk-kit && npm i ``` ## 📜 Usage diff --git a/packages/identity/README.md b/packages/identity/README.md index 4890a73..e777209 100644 --- a/packages/identity/README.md +++ b/packages/identity/README.md @@ -6,17 +6,17 @@

- - Github license + + Github license - - NPM version + + NPM version - - Downloads + + Downloads - - npm bundle size (scoped) + + npm bundle size (scoped) Linter eslint @@ -32,16 +32,16 @@ ### npm or yarn -Install the `@zkit/identity` package with npm: +Install the `@zk-kit/identity` package with npm: ```bash -npm i @zkit/identity +npm i @zk-kit/identity ``` or yarn: ```bash -yarn add @zkit/identity +yarn add @zk-kit/identity ``` ## 📜 Usage @@ -49,11 +49,11 @@ yarn add @zkit/identity **Import** ```typescript -import { ZkIdentity, Identity } from "@zkit/identity" +import { ZkIdentity, Identity } from "@zk-kit/identity" ``` ```javascript -const { ZkIdentity } = require("@zkit/identity") +const { ZkIdentity } = require("@zk-kit/identity") ``` **Mainpulation** diff --git a/packages/identity/package.json b/packages/identity/package.json index ec33ade..b886685 100644 --- a/packages/identity/package.json +++ b/packages/identity/package.json @@ -1,5 +1,5 @@ { - "name": "@zkit/identity", + "name": "@zk-kit/identity", "version": "1.0.22", "description": "Library for managing identities for Semaphore and RLN protocols.", "license": "MIT", @@ -9,8 +9,8 @@ "import": "./dist/index.mjs", "require": "./dist/index.node.js" }, - "repository": "https://github.com/appliedzkp/zkit", - "homepage": "https://github.com/appliedzkp/zkit/tree/main/packages/identity", + "repository": "https://github.com/appliedzkp/zk-kit", + "homepage": "https://github.com/appliedzkp/zk-kit/tree/main/packages/identity", "scripts": { "clean": "rimraf ./dist", "build:watch": "rollup -c rollup.config.ts -w", @@ -25,7 +25,7 @@ "access": "public" }, "dependencies": { - "@zkit/types": "^1.0.9", + "@zk-kit/types": "^1.0.9", "bigint-conversion": "^2.1.12", "circomlibjs": "^0.0.8", "crypto": "^1.0.1", diff --git a/packages/protocols/README.md b/packages/protocols/README.md index 69687ab..afe8347 100644 --- a/packages/protocols/README.md +++ b/packages/protocols/README.md @@ -6,17 +6,17 @@

- - Github license + + Github license - - NPM version + + NPM version - - Downloads + + Downloads - - npm bundle size (scoped) + + npm bundle size (scoped) Linter eslint @@ -32,16 +32,16 @@ ### npm or yarn -Install the `@zkit/protocols` package with npm: +Install the `@zk-kit/protocols` package with npm: ```bash -npm i @zkit/protocols +npm i @zk-kit/protocols ``` or yarn: ```bash -yarn add @zkit/protocols +yarn add @zk-kit/protocols ``` ## 📜 Usage @@ -49,7 +49,7 @@ yarn add @zkit/protocols **Import** ```typescript -import { ZkIdentity, Identity } from "@zkit/identity" +import { ZkIdentity, Identity } from "@zk-kit/identity" import { Semaphore, MerkleProof, @@ -57,12 +57,12 @@ import { generateMerkleProof, genExternalNullifier, genSignalHash -} from "@zkit/protocols" +} from "@zk-kit/protocols" ``` ```javascript -const { ZkIdentity } = require("@zkit/identity") -const { Semaphore, Rln, NRln, generateMerkleProof, genExternalNullifier, genSignalHash } = require("@zkit/protocols") +const { ZkIdentity } = require("@zk-kit/identity") +const { Semaphore, Rln, NRln, generateMerkleProof, genExternalNullifier, genSignalHash } = require("@zk-kit/protocols") ``` **Merkle Proofs** diff --git a/packages/protocols/package.json b/packages/protocols/package.json index 09b4465..65c1c4b 100644 --- a/packages/protocols/package.json +++ b/packages/protocols/package.json @@ -1,5 +1,5 @@ { - "name": "@zkit/protocols", + "name": "@zk-kit/protocols", "version": "1.0.27", "description": "Client library for generating and verifying Semaphore & RLN ZK proofs.", "license": "MIT", @@ -9,8 +9,8 @@ "import": "./dist/index.mjs", "require": "./dist/index.node.js" }, - "repository": "https://github.com/appliedzkp/zkit", - "homepage": "https://github.com/appliedzkp/zkit/tree/main/packages/protocols", + "repository": "https://github.com/appliedzkp/zk-kit", + "homepage": "https://github.com/appliedzkp/zk-kit/tree/main/packages/protocols", "scripts": { "tsc": "npx tsc src/index.ts", "build": "rimraf dist && rollup -c rollup.config.ts" @@ -24,7 +24,7 @@ "access": "public" }, "dependencies": { - "@zkit/types": "^1.0.9", + "@zk-kit/types": "^1.0.9", "circomlibjs": "^0.0.8", "ethers": "^5.4.7", "incrementalquintree": "^1.0.7", diff --git a/packages/types/README.md b/packages/types/README.md index 0ba7cb5..6be85d6 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -6,14 +6,14 @@

- - Github license + + Github license - - NPM version + + NPM version - - Downloads + + Downloads Linter eslint @@ -29,16 +29,16 @@ ### npm or yarn -Install the `@zkit/types` package with npm: +Install the `@zk-kit/types` package with npm: ```bash -npm i @zkit/types +npm i @zk-kit/types ``` or yarn: ```bash -yarn add @zkit/types +yarn add @zk-kit/types ``` ## 📜 Usage @@ -46,5 +46,5 @@ yarn add @zkit/types **Import** ```typescript -import { Identity, IProof, MerkleProof } from "@zkit/types" +import { Identity, IProof, MerkleProof } from "@zk-kit/types" ``` diff --git a/packages/types/package.json b/packages/types/package.json index d9c1d02..eaebcc4 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,12 +1,12 @@ { - "name": "@zkit/types", + "name": "@zk-kit/types", "version": "1.0.9", "description": "Common type definitions for Semaphore modules.", "license": "MIT", "main": "src/index.ts", "types": "dist/index.d.ts", - "repository": "https://github.com/appliedzkp/zkit", - "homepage": "https://github.com/appliedzkp/zkit/tree/main/packages/protocols", + "repository": "https://github.com/appliedzkp/zk-kit", + "homepage": "https://github.com/appliedzkp/zk-kit/tree/main/packages/protocols", "scripts": { "tsc": "npx tsc src/index.ts", "build": "npm run clean && tsc -p .",