Skip to content

Commit

Permalink
add buf dependency intructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sachaw committed Dec 17, 2023
1 parent dc316e6 commit 914ac9e
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,27 @@ Meshtastic.js is a JavaScript library that provides an interface to [Meshtastic]

The library is available from [NPM](https://www.npmjs.com/package/@meshtastic/meshtasticjs) and can be installed with:

```bash
pnpm config set @buf:registry https://buf.build/gen/npm/v1
```

Alternatevly, create a `.npmrc` file with the following contents:

```conf
@buf:registry=https://buf.build/gen/npm/v1
```

Finally, install the package:

```bash
pnpm add @meshtastic/meshtasticjs
```



## Development & Building

Finally the project can be built:
The project can be built by running:

```bash
pnpm build
Expand Down

0 comments on commit 914ac9e

Please sign in to comment.