From 914ac9e265591290d67ef3dd42eb397b4dbf992f Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Sun, 17 Dec 2023 12:34:40 +1000 Subject: [PATCH] add buf dependency intructions to readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c418bbf..5ad777e 100755 --- a/README.md +++ b/README.md @@ -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