Skip to content

Commit

Permalink
chore: README says to 'npm install' (#19)
Browse files Browse the repository at this point in the history
Motivation:
* I forgot to do it and ran `npm start` which did `wrangler dev` and
used my globally installed wrangler and led to an initially confusing
error message. If this was here, I woulda run it and not gotten the
momentary confuse
  • Loading branch information
gobengo authored Dec 14, 2023
1 parent 26b06e6 commit f7c5328
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Install `node` >= 18, and `wrangler` >= 3

Copy `.example.dev.vars` to `.dev.vars` and set the AWS access keys vars.

Run `npm install` to install package dependencies.

Run `npm start` to start a local dev server

```sh
Expand All @@ -28,15 +30,15 @@ Run `example/dial.js` to make a test connection to your local dev server
```sh
$ node example/dial.js /ip4/127.0.0.1/tcp/8787/ws/p2p/12D3KooWJA2ETdy5wYTbCHVqKdgrqtmuNEwjMVMwEtMrNugrsGkZ
Connected to hoverboard 🛹 /ip4/127.0.0.1/tcp/8787/ws/p2p/12D3KooWJA2ETdy5wYTbCHVqKdgrqtmuNEwjMVMwEtMrNugrsGkZ
```
```

Run `example/bitswap.js` to bitswap some blocks from staging, or pass your local multiaddr to try against dev.

```sh
$ node example/bitswap.js
Connecting to /dns4/hoverboard-staging.dag.haus/tcp/443/wss/p2p/Qmc5vg9zuLYvDR1wtYHCaxjBHenfCNautRwCjG3n5v5fbs
Fetching bafybeicm3skx7ps2bwkh56l3mirh3hu4hmkfttfwjkmk4cr25sxtf2jmby
```
```

## Secrets

Expand Down

0 comments on commit f7c5328

Please sign in to comment.