From 6032a69af3d0b244d0c6a624baa386b31c938fb7 Mon Sep 17 00:00:00 2001
From: Zynh Ludwig <zynh0722@gmail.com>
Date: Sun, 12 Jan 2025 18:43:54 -0800
Subject: [PATCH] docs: include env variables in readme

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

diff --git a/README.md b/README.md
index e69de29..d32f44e 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,14 @@
+# Nyazoom<sup>2</sup>
+
+README is a supreme work in progress, terribly sorry
+
+## Env Variables
+
+<!-- markdownlint-disable MD013 -->
+
+| variable    | description                                   | default                  |
+| ----------- | --------------------------------------------- | ------------------------ |
+| `CACHE_DIR` | the location for storing all downloaded files | "/var/lib/nyazoom/cache" |
+| `DIST_DIR`  | location of the folder to be static served    | "./dist"                 |
+
+<!-- markdownlint-enable -->