From 2bee49a00044486bd025f31bcbbeb1a1aefe7ea8 Mon Sep 17 00:00:00 2001 From: Tom Petr Date: Tue, 19 Nov 2024 17:34:33 -0500 Subject: [PATCH] add note about buf (#92) --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae40b53..b19eeb1 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,10 @@ Examples of inbound traffic include: ### Build -- Run `make build` to generate the `semgrep-network-broker` binary -- Run `make docker` to generate a docker image +NOTE: The Semgrep Network broker uses [Buf](https://buf.build/) for protobuf compilation. If you are building the broker from scratch outside of Docker, make sure you have the Buf CLI installed: https://buf.build/docs/installation + +- Run `make build` to build the `semgrep-network-broker` binary locally +- Run `make docker` to build a docker image - Docker images are also published to [ghcr.io/semgrep/semgrep-network-broker](https://github.com/semgrep/semgrep-network-broker/pkgs/container/semgrep-network-broker) ### Keypairs