From ed6d0ad76f12797d8eb19ab480954d6f9ae75add Mon Sep 17 00:00:00 2001 From: Timo Stamm Date: Wed, 2 Oct 2024 16:56:33 +0200 Subject: [PATCH] Reword buf CLI requirements --- npm-packages/protocompile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/npm-packages/protocompile/README.md b/npm-packages/protocompile/README.md index 8721360..8ab3ebf 100644 --- a/npm-packages/protocompile/README.md +++ b/npm-packages/protocompile/README.md @@ -27,6 +27,6 @@ describe("redact", () => { The package also exports functions to compile Protobuf descriptors for all other types, such as enumerations and services. -Under the hood, the functions shell out to the `buf build` command. You have to install [@bufbuild/buf](https://www.npmjs.com/package/@bufbuild/buf) to use them. +Under the hood, the functions shell out to the `buf build` command. You need [@bufbuild/buf](https://www.npmjs.com/package/@bufbuild/buf) as a peer dependency to use them. Note that the functions return anonymous descriptors. They are functionally identical to generated descriptors, but do not have generated type information attached.