From d1202a03fa64367e59e6471fb28a07e9c6a33646 Mon Sep 17 00:00:00 2001
From: Wavering Ana <ana@nekomimi.pet>
Date: Fri, 31 Jan 2025 19:46:31 -0500
Subject: [PATCH] update readme

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

diff --git a/README.md b/README.md
index 3f4ff4c..6ef85bd 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,25 @@ A very performant and light (6mb in memory) link shortener and tracker. Written
 
 ![StatsView](readme_img/statview.jpg)
 
+## How to Run
+
+### From Docker:
+
+```Bash
+docker run -p 8080:8080 \
+    -e JWT_SECRET=change-me-in-production \
+    -v simplelink_data:/data \
+    simplelink
+```
+
+Find the admin-setup-token pasted into the terminal output, or in admin-setup-token.txt in the container's root.
+
+This is needed to register with the frontend. (TODO, register admin account with ENV)
+
+### From Docker Compose:
+
+Edit the docker-compose.yml file. It comes included with a postgressql db for use
+
 ## Build
 
 ### From Source