From 9b811640eef2ba06accba0a5dc268b54c28064c5 Mon Sep 17 00:00:00 2001
From: gabe <gabeklav@fastmail.com>
Date: Thu, 14 Mar 2024 22:50:22 -0400
Subject: [PATCH] docs(repo): add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..03ec4e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# YGL Aggregator
+
+Go server + website + Python scraper
+
+## Run with Docker
+- Make sure you build latest
+```sh
+docker compose build
+```
+
+- Populate your `.env` file (take a look at `.env-example`)
+
+- Then run with docker compose
+```sh
+docker compose up -d
+```