From 9703fbb62dad7930619f670e006d4c53cb32dd7f Mon Sep 17 00:00:00 2001
From: b1ek <me@blek.codes>
Date: Wed, 1 Mar 2023 16:05:28 +1000
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
index 035af8d..9729e39 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
 # homepage.js
 This is a rewrite of my current website to Express.JS.
+
+# Running an instance
+
+### Debug
+```bash
+cp .env.example .env
+APP_DEBUG=true sudo ./install
+docker-compose up -d
+```
+
+### Production
+Note: production instance is not production-ready yet, as it is still in development mode.
+
+```bash
+cp .env.example .env
+echo "APP_DEBUG=false" >> .env # Or edit the file yourself
+sudo ./install
+docker-compose up -d
+```
\ No newline at end of file