From c8e4afe0d9dd64ada14b3848ca978fc7727119a8 Mon Sep 17 00:00:00 2001
From: Evan Lihou <3743825+evanlihou@users.noreply.github.com>
Date: Fri, 10 May 2024 22:22:51 -0400
Subject: [PATCH] Update README.md

---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f4c359a..2c43a70 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,10 @@
-# db
-Database schema(s)
+# FiM DB Schema
+This repository contains the schema and migrations for the main databased used by FiM internal tooling.
+
+## Working Locally
+It's recommended to use the [Supabase CLI](https://supabase.com/docs/guides/cli) to spin up a local database or create new migrations. Please be mindful when creating new migrations that old data in the database may not match your new schema. Run updates on existing data where appropriate to fit it to new schemas.
+
+## CI/CD
+Each commit on main or a PR into main will start an action which validates all migrations, then spins up a new database to ensure they apply without error. This action passing is required for a PR to get merged.
+
+Once changes have been merged into main, a trusted repo maintainer can approve a deployment to prod, at which point the changes will go live.