Skip to content

Commit a5b6bc7

Browse files
authored
chore(npm): update README.md of npm packages (#12459)
1 parent da99e6b commit a5b6bc7

File tree

8 files changed

+228
-4
lines changed

8 files changed

+228
-4
lines changed

npm/@foundry-rs/anvil/README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,52 @@
1-
# Anvil
1+
# [Anvil](https://getfoundry.sh/anvil)
22

33
Anvil is a fast local Ethereum development node.
44
The anvil binary can be used both within and outside of a Foundry project.
5+
6+
## Usage
7+
8+
### One-off commands
9+
10+
Example
11+
12+
```sh
13+
npx --yes @foundry-rs/anvil@nightly
14+
```
15+
16+
More generally
17+
18+
```sh
19+
npx --yes @foundry-rs/anvil@<version|nightly> [args...]
20+
```
21+
22+
### Install then use
23+
24+
locally to your project
25+
26+
```sh
27+
npm add @foundry-rs/anvil@nightly
28+
npx anvil [args...]
29+
```
30+
31+
globally
32+
33+
```sh
34+
npm add --global @foundry-rs/anvil@nightly
35+
anvil [args...]
36+
```
37+
38+
---
39+
40+
Also works with `deno`, `bun`, and `pnpm`:
41+
42+
```sh
43+
deno run --quiet --allow-all npm:@foundry-rs/anvil@nightly [args...]
44+
```
45+
46+
```sh
47+
bun x @foundry-rs/anvil@nightly [args...]
48+
```
49+
50+
```sh
51+
pnpm dlx --silent @foundry-rs/anvil@nightly [args...]
52+
```

npm/@foundry-rs/anvil/package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"provenance": true,
2727
"registry": "https://registry.npmjs.org"
2828
},
29+
"keywords": [
30+
"foundry",
31+
"testing",
32+
"ethereum",
33+
"solidity",
34+
"blockchain",
35+
"smart-contracts"
36+
],
2937
"license": "MIT OR Apache-2.0",
3038
"repository": {
3139
"directory": "npm",

npm/@foundry-rs/cast/README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
1-
# Cast
1+
# [Cast](https://getfoundry.sh/cast)
22

33
Cast is a Swiss Army knife for interacting with Ethereum applications from the command line.
44
You can make smart contract calls, send transactions, or retrieve any type of chain data - all from your command-line!
55
The cast binary can be used both within and outside of a Foundry project.
6+
7+
## Usage
8+
9+
### One-off commands
10+
11+
Example
12+
13+
```sh
14+
npx --yes @foundry-rs/cast@nightly block-number
15+
```
16+
17+
More generally
18+
19+
```sh
20+
npx --yes @foundry-rs/cast@<version|nightly> <command> [args...]
21+
```
22+
23+
### Install then use
24+
25+
locally to your project
26+
27+
```sh
28+
npm add @foundry-rs/cast@nightly
29+
npx cast <command> [args...]
30+
```
31+
32+
globally
33+
34+
```sh
35+
npm add --global @foundry-rs/cast@nightly
36+
cast <command> [args...]
37+
```
38+
39+
---
40+
41+
Also works with `deno`, `bun`, and `pnpm`:
42+
43+
```sh
44+
deno run --quiet --allow-all npm:@foundry-rs/cast@nightly <command> [args...]
45+
```
46+
47+
```sh
48+
bun x @foundry-rs/cast@nightly <command> [args...]
49+
```
50+
51+
```sh
52+
pnpm dlx --silent @foundry-rs/cast@nightly <command> [args...]
53+
```

npm/@foundry-rs/cast/package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"provenance": true,
2727
"registry": "https://registry.npmjs.org"
2828
},
29+
"keywords": [
30+
"foundry",
31+
"testing",
32+
"ethereum",
33+
"solidity",
34+
"blockchain",
35+
"smart-contracts"
36+
],
2937
"license": "MIT OR Apache-2.0",
3038
"repository": {
3139
"directory": "npm",

npm/@foundry-rs/chisel/README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,52 @@
1-
# Chisel
1+
# [Chisel](https://getfoundry.sh/chisel)
22

33
Chisel is a fast, utilitarian, and verbose Solidity REPL.
44
The chisel binary can be used both within and outside of a Foundry project.
5+
6+
## Usage
7+
8+
### One-off commands
9+
10+
Example
11+
12+
```sh
13+
npx --yes @foundry-rs/chisel@nightly
14+
```
15+
16+
More generally
17+
18+
```sh
19+
npx --yes @foundry-rs/chisel@<version|nightly> [args...]
20+
```
21+
22+
### Install then use
23+
24+
locally to your project
25+
26+
```sh
27+
npm add @foundry-rs/chisel@nightly
28+
npx chisel [args...]
29+
```
30+
31+
globally
32+
33+
```sh
34+
npm add --global @foundry-rs/chisel@nightly
35+
chisel [args...]
36+
```
37+
38+
---
39+
40+
Also works with `deno`, `bun`, and `pnpm`:
41+
42+
```sh
43+
deno run --quiet --allow-all npm:@foundry-rs/chisel@nightly [args...]
44+
```
45+
46+
```sh
47+
bun x @foundry-rs/chisel@nightly [args...]
48+
```
49+
50+
```sh
51+
pnpm dlx --silent @foundry-rs/chisel@nightly [args...]
52+
```

npm/@foundry-rs/chisel/package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"provenance": true,
2727
"registry": "https://registry.npmjs.org"
2828
},
29+
"keywords": [
30+
"foundry",
31+
"testing",
32+
"ethereum",
33+
"solidity",
34+
"blockchain",
35+
"smart-contracts"
36+
],
2937
"license": "MIT OR Apache-2.0",
3038
"repository": {
3139
"directory": "npm",

npm/@foundry-rs/forge/README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,52 @@
1-
# Forge
1+
# [Forge](https://getfoundry.sh/forge)
22

33
Forge is a command-line tool that ships with Foundry. Forge tests, builds, and deploys your smart contracts.
44
The forge binary can be used both within and outside of a Foundry project.
5+
6+
## Usage
7+
8+
### One-off commands
9+
10+
Example
11+
12+
```sh
13+
npx --yes @foundry-rs/forge@nightly init
14+
```
15+
16+
More generally
17+
18+
```sh
19+
npx --yes @foundry-rs/forge@<version|nightly> <command> [args...]
20+
```
21+
22+
### Install then use
23+
24+
locally to your project
25+
26+
```sh
27+
npm add @foundry-rs/forge@nightly
28+
npx forge <command> [args...]
29+
```
30+
31+
globally
32+
33+
```sh
34+
npm add --global @foundry-rs/forge@nightly
35+
forge <command> [args...]
36+
```
37+
38+
---
39+
40+
Also works with `deno`, `bun`, and `pnpm`:
41+
42+
```sh
43+
deno run --quiet --allow-all npm:@foundry-rs/forge@nightly <command> [args...]
44+
```
45+
46+
```sh
47+
bun x @foundry-rs/forge@nightly <command> [args...]
48+
```
49+
50+
```sh
51+
pnpm dlx --silent @foundry-rs/forge@nightly <command> [args...]
52+
```

npm/@foundry-rs/forge/package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"provenance": true,
2727
"registry": "https://registry.npmjs.org"
2828
},
29+
"keywords": [
30+
"foundry",
31+
"testing",
32+
"ethereum",
33+
"solidity",
34+
"blockchain",
35+
"smart-contracts"
36+
],
2937
"license": "MIT OR Apache-2.0",
3038
"repository": {
3139
"directory": "npm",

0 commit comments

Comments
 (0)