From f2c474daf0823af9907f5bdabc06f4c6980dcf5c Mon Sep 17 00:00:00 2001
From: Hazem Krimi <me@hazemkrimi.tech>
Date: Mon, 4 Aug 2025 12:32:47 +0100
Subject: [PATCH] chore: add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6714173
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Crimson Vault
+
+Simple invoicing solution for small businesses that is open source and self-hosted written in Go.
+
+# Development
+
+This project uses [Air](https://github.com/air-verse/air) for live reloading so you can simply run the following command to get reloading on save:
+
+```
+air
+```
+
+For migrations the project is using [Atlas GORM Provider](https://github.com/ariga/atlas-provider-gorm) for migrations. To save a migration run the follwing command:
+
+```
+atlas migrate diff --env gorm
+```
+
+And to apply a migration on your development database you will need to run the following command:
+
+```
+atlas schema apply --env gorm -u "your database connection string"
+```