From 8a806d76e018415aac7f414342d70d5ec07081c0 Mon Sep 17 00:00:00 2001
From: phoenix <kundeng00@pm.me>
Date: Sun, 27 Apr 2025 12:19:09 -0400
Subject: [PATCH] Updated readme

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index e69de29..b56d1e1 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,26 @@
+
+
+# Getting Started
+Copy the `.env.sample` file to `.env` and ensure that the variables are populated. This project
+can be used with regular hosting or with docker. For the sake of getting up to speed quickly,
+Docker will be covered. Make sure docker is running and your ssh identity has been loaded.
+
+Build image
+```
+docker compose build
+```
+
+Start images
+```
+docker compose up -d --force-recreate
+```
+
+Bring it down
+```
+docker compose down -v
+```
+
+Pruning
+```
+docker system prune -a
+```