From 5fafd29d91c6aec3bd275a13dc83abea28a60d4c Mon Sep 17 00:00:00 2001 From: Hunter Thornsberry Date: Wed, 11 Sep 2024 23:18:14 -0400 Subject: [PATCH] protobuf readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index ba64a5b5..364cf0fb 100644 --- a/README.md +++ b/README.md @@ -59,3 +59,15 @@ Start the development server: ```bash pnpm dev ``` + +### Updating Protobufs + +To update to the latest protobufs go to https://buf.build/meshtastic/protobufs/sdks and select plugin version `1.10`. + +The version should look something like this: `1.10.0-20240906232734-3da561588c55.1` + +Where the version is *always* `1.10.0` followed by a timestamp and a commit hash. Updating to an SDK version higher than 1.10.0 has breaking changes. + +Use that version to updated your `package.json` file. + +*Ensure to keep the `meshtastic/js` protobufs in step with web* \ No newline at end of file