Skip to content

Commit 3c626bd

Browse files
committed
cli: update README.md
1 parent 9273577 commit 3c626bd

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

cli/README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
11
# NTT cli
22

3-
To install dependencies:
3+
## Prerequisites
44

5-
```bash
6-
bun install --frozen-lockfile
5+
- [bun](https://bun.sh/docs/installation)
6+
7+
Depending on the platforms you will deploy on:
8+
- [foundry](https://book.getfoundry.sh/) (evm)
9+
- [anchor](https://book.anchor-lang.com/getting_started/installation.html) (solana)
10+
11+
## Installation
12+
13+
Run
14+
15+
``` bash
16+
curl -fsSL https://raw.githubusercontent.com/wormhole-foundation/example-native-token-transfers/main/cli/install.sh | bash
717
```
818

9-
To install `ntt` binary:
19+
The installer will put the `ntt` binary in `$HOME/.bun/bin`, so make sure that directory is included in your `$PATH`. Once `ntt` is installed, it can be updated to the latest release any time by running
1020

1121
``` bash
12-
bun link cli
22+
ntt update
1323
```
1424

15-
To run:
25+
Or to a specific branch by running
1626

17-
```bash
18-
ntt --help
27+
``` bash
28+
ntt update --branch foo
29+
```
30+
31+
## Development
32+
33+
The easiest way to work on the CLI is to first install using the script above, then clone the repo, and run
34+
35+
``` bash
36+
ntt update --path path/to/ntt/repo
1937
```

0 commit comments

Comments
 (0)