Skip to content

Commit 7857f6c

Browse files
committed
docs: update yarn commands to pnpm in README files
1 parent b8da173 commit 7857f6c

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ For detailed CLI `generate` commands, please refer to our documentation.
142142
You can download proto files using the `download-protos` command provided in the boilerplate:
143143

144144
```sh
145-
yarn download-protos
145+
pnpm download-protos
146146
```
147147

148148
After running this command, you'll see:
@@ -153,19 +153,19 @@ These proto files are downloaded based on your configuration. For detailed CLI `
153153

154154
### Transpile
155155

156-
To generate TypeScript files for your chain, run the `yarn codegen` command:
156+
To generate TypeScript files for your chain, run the `pnpm codegen` command:
157157

158158
```sh
159-
yarn codegen
159+
pnpm codegen
160160
```
161161

162162
### Build
163163

164164
Finally, build your package to generate JavaScript files and TypeScript definitions:
165165

166166
```sh
167-
yarn install
168-
yarn build
167+
pnpm install
168+
pnpm build
169169
```
170170

171171
### Publishing
@@ -374,36 +374,36 @@ Next, navigate to the `./your-project/packages/telescope` directory.
374374

375375
Install dependencies and download the proto files you need:
376376
```sh
377-
yarn install
377+
pnpm install
378378
telescope download --config ./your.config.json
379379
```
380380

381381
Generate TypeScript files for your chain:
382382

383383
```sh
384-
yarn codegen
384+
pnpm codegen
385385
```
386386

387387
### Manual Install
388388

389389
To use Telescope in an existing project, run the following command in your project directory:
390390
```sh
391-
yarn add --dev @hyperweb/telescope
391+
pnpm add --save-dev @hyperweb/telescope
392392
```
393393
Also install the required helpers and CosmJS [dependencies listed here](#dependencies).
394394

395395
We recommend using [Programmatic Usage](#programmatic-usage) for better integration.
396396

397-
You can also use the [Telescope CLI](#telescope-cli). When using CLI commands within your project, prefix them with `npx` or `yarn`. For example:
398-
- `yarn telescope generate`
397+
You can also use the [Telescope CLI](#telescope-cli). When using CLI commands within your project, prefix them with `npx` or `pnpm`. For example:
398+
- `pnpm telescope generate`
399399
- `npx telescope download`
400400

401401
### Programmatic Usage
402402

403403
First add telescope to your `devDependencies`:
404404

405405
```sh
406-
yarn add --dev @hyperweb/telescope
406+
pnpm add --save-dev @hyperweb/telescope
407407
```
408408

409409
Install the required helpers and CosmJS [dependencies listed here](#dependencies).
@@ -1504,15 +1504,15 @@ If you don't use the boilerplate, you will need to manually install
15041504
* `@cosmjs/tendermint-rpc`
15051505
15061506
```sh
1507-
yarn add @cosmjs/amino @cosmjs/proto-signing @cosmjs/stargate @cosmjs/tendermint-rpc
1507+
pnpm add @cosmjs/amino @cosmjs/proto-signing @cosmjs/stargate @cosmjs/tendermint-rpc
15081508
```
15091509
15101510
If you use the LCD Client generation, you'll need to add
15111511
15121512
* `@cosmology/lcd`
15131513
15141514
```sh
1515-
yarn add @cosmology/lcd
1515+
pnpm add @cosmology/lcd
15161516
```
15171517
15181518
## Troubleshooting

packages/telescope/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ For detailed CLI `generate` commands, please refer to our documentation.
142142
You can download proto files using the `download-protos` command provided in the boilerplate:
143143

144144
```sh
145-
yarn download-protos
145+
pnpm download-protos
146146
```
147147

148148
After running this command, you'll see:
@@ -153,19 +153,19 @@ These proto files are downloaded based on your configuration. For detailed CLI `
153153

154154
### Transpile
155155

156-
To generate TypeScript files for your chain, run the `yarn codegen` command:
156+
To generate TypeScript files for your chain, run the `pnpm codegen` command:
157157

158158
```sh
159-
yarn codegen
159+
pnpm codegen
160160
```
161161

162162
### Build
163163

164164
Finally, build your package to generate JavaScript files and TypeScript definitions:
165165

166166
```sh
167-
yarn install
168-
yarn build
167+
pnpm install
168+
pnpm build
169169
```
170170

171171
### Publishing
@@ -374,36 +374,36 @@ Next, navigate to the `./your-project/packages/telescope` directory.
374374

375375
Install dependencies and download the proto files you need:
376376
```sh
377-
yarn install
377+
pnpm install
378378
telescope download --config ./your.config.json
379379
```
380380

381381
Generate TypeScript files for your chain:
382382

383383
```sh
384-
yarn codegen
384+
pnpm codegen
385385
```
386386

387387
### Manual Install
388388

389389
To use Telescope in an existing project, run the following command in your project directory:
390390
```sh
391-
yarn add --dev @hyperweb/telescope
391+
pnpm add --save-dev @hyperweb/telescope
392392
```
393393
Also install the required helpers and CosmJS [dependencies listed here](#dependencies).
394394

395395
We recommend using [Programmatic Usage](#programmatic-usage) for better integration.
396396

397-
You can also use the [Telescope CLI](#telescope-cli). When using CLI commands within your project, prefix them with `npx` or `yarn`. For example:
398-
- `yarn telescope generate`
397+
You can also use the [Telescope CLI](#telescope-cli). When using CLI commands within your project, prefix them with `npx` or `pnpm`. For example:
398+
- `pnpm telescope generate`
399399
- `npx telescope download`
400400

401401
### Programmatic Usage
402402

403403
First add telescope to your `devDependencies`:
404404

405405
```sh
406-
yarn add --dev @hyperweb/telescope
406+
pnpm add --save-dev @hyperweb/telescope
407407
```
408408

409409
Install the required helpers and CosmJS [dependencies listed here](#dependencies).
@@ -1504,15 +1504,15 @@ If you don't use the boilerplate, you will need to manually install
15041504
* `@cosmjs/tendermint-rpc`
15051505
15061506
```sh
1507-
yarn add @cosmjs/amino @cosmjs/proto-signing @cosmjs/stargate @cosmjs/tendermint-rpc
1507+
pnpm add @cosmjs/amino @cosmjs/proto-signing @cosmjs/stargate @cosmjs/tendermint-rpc
15081508
```
15091509
15101510
If you use the LCD Client generation, you'll need to add
15111511
15121512
* `@cosmology/lcd`
15131513
15141514
```sh
1515-
yarn add @cosmology/lcd
1515+
pnpm add @cosmology/lcd
15161516
```
15171517
15181518
## Troubleshooting

0 commit comments

Comments
 (0)