Readme

loicalleyne · Nov 23, 2024 · 512052e · 512052e
1 parent 3b333bc
commit 512052e
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@ notes.md
 tmp
 internal
 cmd
-*.yaml
+*.yaml
+test
diff --git a/LICENSE → LICENCE b/LICENSE → LICENCE
diff --git 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)
diff --git 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
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,5 @@ notes.md @@
     tmp
     internal
     cmd
-    *.yaml
+    *.yaml
+    test