docs(repo): add readme

gabeklavans · Mar 15, 2024 · 9b81164 · 9b81164
1 parent 6f7c46f
commit 9b81164
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md 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
+```