Skip to content

Commit

Permalink
chore: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vic3lord committed Oct 15, 2024
1 parent 092cbd7 commit d8f727f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Bufile

Bufile is a CLI to generate [Linkerd](https://linkerd.io) service profiles
using [Buf Schema Registry](https://buf.build/docs/registry).

## Usage

Here's an example protobuf file that includes the right annotations:

https://github.com/vic3lord/bufile/blob/main/proto/testbufile/v1/testbufile.proto

```shell
bufile --config <path-to-bufile.json>
```

0 comments on commit d8f727f

Please sign in to comment.