diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7553941a..38cbf1e3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,7 +6,7 @@ Hello, contributor! Thanks for thinking about helping with the zkSync CLI projec ## Getting Started -- **Fork the project.** First, fork the `zksync-cli` repository. +- **Fork the project.** First, fork the `zksync-cli` repository to your GitHub account. - **Download the project.** Now, get the project on your computer: diff --git a/README.md b/README.md index 43d10d40..6ac8f8bb 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Or you can install the CLI globally with `npm i -g zksync-cli` and run the comma In addition to default modules, you can install custom modules from NPM. -- `zksync-cli dev install [module-name]` - install module with NPM (e.g. `zksync-cli dev i zksync-cli-dummy-module`) +- `zksync-cli dev install [module-name]` - install module with NPM (e.g. `zksync-cli dev i zkcli-dummy-module`) - `zksync-cli dev modules` - displays list of installed modules Run `zksync-cli dev` to see the full list of commands. diff --git a/src/commands/dev/modules/utils/packages.ts b/src/commands/dev/modules/utils/packages.ts index 5daa42cd..b99bb994 100644 --- a/src/commands/dev/modules/utils/packages.ts +++ b/src/commands/dev/modules/utils/packages.ts @@ -99,26 +99,26 @@ export const findDefaultModules = async (): Promise => { type PackageJSON = { name: string; version: string }; const require = createRequire(import.meta.url); const packages = { - "zksync-cli-in-memory-node": require("zksync-cli-in-memory-node/package.json") as PackageJSON, - "zksync-cli-dockerized-node": require("zksync-cli-dockerized-node/package.json") as PackageJSON, - "zksync-cli-portal": require("zksync-cli-portal/package.json") as PackageJSON, + "zkcli-in-memory-node": require("zkcli-in-memory-node/package.json") as PackageJSON, + "zkcli-dockerized-node": require("zkcli-dockerized-node/package.json") as PackageJSON, + "zkcli-portal": require("zkcli-portal/package.json") as PackageJSON, } as const; return [ { module: ModuleInMemoryNode as unknown as Module, - name: packages["zksync-cli-in-memory-node"].name, - version: packages["zksync-cli-in-memory-node"].version, + name: packages["zkcli-in-memory-node"].name, + version: packages["zkcli-in-memory-node"].version, }, { module: ModuleDockerizedNode as unknown as Module, - name: packages["zksync-cli-dockerized-node"].name, - version: packages["zksync-cli-dockerized-node"].version, + name: packages["zkcli-dockerized-node"].name, + version: packages["zkcli-dockerized-node"].version, }, { module: ModulePortal as unknown as Module, - name: packages["zksync-cli-portal"].name, - version: packages["zksync-cli-portal"].version, + name: packages["zkcli-portal"].name, + version: packages["zkcli-portal"].version, }, ]; };