15 lines
640 B
Markdown
15 lines
640 B
Markdown
|
# Buf
|
||
|
|
|
||
|
|
> `buf` is a high-performance `protoc` replacement.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
See installation instructions [here](https://docs.buf.build/installation/).
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
`make proto` in the root of this repo will invoke `buf` using the configuration in this directory.
|
||
|
|
|
||
|
|
## Why use `buf` instead of `protoc`?
|
||
|
|
|
||
|
|
Buf is a user-friendly tool to work with Protobuf that outperforms `protoc` in every conceivable way. It was written by the author(s) of [`prototool`](https://github.com/uber/prototool), another tool that made generating Protobuf easier, but which is now deprecated in favor of `buf`. Buf also does linting and breaking-change detection.
|