From 8ac83c908a080f1612e430dc8ad2f11380c2d560 Mon Sep 17 00:00:00 2001 From: Iain McGinniss <309153+iainmcgin@users.noreply.github.com> Date: Thu, 2 Apr 2026 20:51:28 +0000 Subject: [PATCH] Add crates.io as primary cargo install source for protoc plugins Both protoc-gen-buffa and protoc-gen-buffa-packaging are now published on crates.io, so 'cargo install --locked protoc-gen-buffa protoc-gen-buffa-packaging' is the friendlier path for most users. Keep the --git form as a fallback for unreleased changes. --- docs/guide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/guide.md b/docs/guide.md index fdddbaf..cf7dfba 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -275,8 +275,16 @@ There are two binaries: `protoc-gen-buffa` (the codegen plugin) and `protoc-gen- **From source (requires Rust toolchain):** +From crates.io (recommended): + +```sh +cargo install --locked protoc-gen-buffa protoc-gen-buffa-packaging +``` + +Or from a git ref, for unreleased changes: + ```sh -cargo install --git https://github.com/anthropics/buffa protoc-gen-buffa protoc-gen-buffa-packaging +cargo install --locked --git https://github.com/anthropics/buffa protoc-gen-buffa protoc-gen-buffa-packaging ``` **From GitHub releases:**