Update README.md

README.md

@@ -1,2 +1,33 @@
-# casbin-bun-adapter
-Bun ORM adapter for Casbin
+# Casbin Bun Adapter
+<p align='left'>
+  <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/JunNishimura/casbin-bun-adapter">
+  <img alt="GitHub" src="https://img.shields.io/github/license/JunNishimura/casbin-bun-adapter">
+  <a href="https://github.com/JunNishimura/casbin-bun-adapter/actions/workflows/test.yml"><img src="https://github.com/JunNishimura/casbin-bun-adapter/actions/workflows/test.yml/badge.svg" alt="test"></a>
+  <a href="https://goreportcard.com/report/github.com/JunNishimura/casbin-bun-adapter"><img src="https://goreportcard.com/badge/github.com/JunNishimura/casbin-bun-adapter" alt="Go Report Card"></a>
+</p>
+
+## 📖 Overview
+casbin-bun-adapter is the [Bun](https://bun.uptrace.dev/) ORM adapter for [Casbin](https://casbin.org/).
+
+## 🙌 Supported DB 
+The following databases supported by Bun are also supported by this adapter
+1. MySQL
+2. PostgreSQL
+3. Microsoft SQL Server
+4. SQLite
+
+## 💻 Installation 
+```
+go get github.com/JunNishimura/casbin-bun-adapter
+```
+
+## 👀 Example
+```go
+
+```
+
+## 🙇‍♂️ Thanks
+I would like to express my appreciation to [Gorm Adapter](https://github.com/casbin/gorm-adapter), since casbin-bun-adapter is implemented in a way that fits the Bun ORM based on it.
+
+## 🪧 License
+casbin-bun-adapter is released under [MIT License](https://github.com/JunNishimura/casbin-bun-adapter/blob/main/LICENSE).