From d8f727f2d61a7a3a65064a95683f0fdb7885aadc Mon Sep 17 00:00:00 2001
From: Or Elimelech <vic3lord@users.noreply.github.com>
Date: Tue, 15 Oct 2024 20:49:34 +0300
Subject: [PATCH] chore: add readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0460f0a
--- /dev/null
+++ b/README.md
@@ -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>
+```