From 512052e6e8d37598b16d4aeb38b253e7625094eb Mon Sep 17 00:00:00 2001
From: loicalleyne <loicalleyne@gmail.com>
Date: Fri, 22 Nov 2024 20:28:33 -0500
Subject: [PATCH] Readme

---
 .gitignore         |  3 ++-
 LICENSE => LICENCE |  0
 README.md          | 33 +++++++++++++++++++++++++++++++--
 buf.gen.yaml       |  2 +-
 4 files changed, 34 insertions(+), 4 deletions(-)
 rename LICENSE => LICENCE (100%)

diff --git a/.gitignore b/.gitignore
index ef94704..11cbcc5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,5 @@ notes.md
 tmp
 internal
 cmd
-*.yaml
\ No newline at end of file
+*.yaml
+test
\ No newline at end of file
diff --git a/LICENSE b/LICENCE
similarity index 100%
rename from LICENSE
rename to LICENCE
diff --git a/README.md b/README.md
index 99cd81f..b1ef57a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
-# arrow3
-Build apache arrow records from protocol buffers
+bufarrow
+===================
+[![Go Reference](https://pkg.go.dev/badge/github.com/loicalleyne/bufarrow.svg)](https://pkg.go.dev/github.com/loicalleyne/bufarrow)
+
+Go library to build Apache Arrow records from Protocol Buffers
+
+## 🚀 Install
+
+Using buffarow is easy. First, use `go get` to install the latest version
+of the library.
+
+```sh
+go get -u github.com/loicalleyne/bufarrow@latest
+```
+
+## 💡 Usage
+
+You can import `bufarrow` using:
+
+```go
+import "github.com/loicalleyne/bufarrow"
+```
+
+## 💫 Show your support
+
+Give a ⭐️ if this project helped you!
+Feedback and PRs welcome.
+
+## License
+
+Bodkin is released under the Apache 2.0 license. See [LICENCE.txt](LICENCE.txt)
\ No newline at end of file
diff --git a/buf.gen.yaml b/buf.gen.yaml
index 19838e0..5cfbade 100644
--- a/buf.gen.yaml
+++ b/buf.gen.yaml
@@ -2,7 +2,7 @@ version: v1
 managed:
   enabled: true
   go_package_prefix:
-    default: github.com/gernest/arrow3/gen/go
+    default: github.com/loicalleyne/bufarrow/gen/go
 
 plugins:
   - plugin: go