Skip to content

Commit

Permalink
Reword buf CLI requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
timostamm committed Oct 2, 2024
1 parent 03f921d commit ed6d0ad
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion npm-packages/protocompile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit ed6d0ad

Please sign in to comment.