From 5f7270f11c7fda20aa9be0cd3aa0cabb6527f501 Mon Sep 17 00:00:00 2001
From: Madeline Williams <73550645+maddiethegm@users.noreply.github.com>
Date: Tue, 10 Feb 2026 20:59:29 -0500
Subject: [PATCH] Update README.md

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 61 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c16cecb..4765e8d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,61 @@
-# Home-Inventory
\ No newline at end of file
+# Home-Inventory
+
+
+
+## Config
+### API Server Configuration
+#### Save these variables in /.env
+The following environment variables are used to configure the application:
+> PORT=
+
+    API server listening port.
+    Default: 3001
+### DB Config
+> DB_USER=
+
+    DB username for read/write access
+> DB_PASSWORD=
+
+    Password to login as DB_USER
+> DB_SERVER=
+
+    DB server URL
+    Example: sql.example.tld
+    Example: localhost
+> DB_DATABASE=
+
+    Your database name
+> DB_TYPE=
+
+    Options: mssql, oracle, mariadb, postgres
+### JWT Configuration
+> JWT_SECRET=
+
+    Example: your_secret_key
+> TOKEN_EXPIRY=
+
+    Example: '8h'
+    Default: '1h'
+### LDAP Config
+> LDAP_URL=
+
+    Example: ldap://example.tld
+> LDAP_DOMAIN_COMPONENTS=
+
+    Example: 'cn=users,dc=example,dc=tld'
+> LDAP_USER_ATTRIBUTE=
+
+    Example: 'cn'
+### React App Config
+Save these variables client folder - default /client/.env
+### API Config
+> REACT_APP_API_URL=
+
+    URL to reach your API backend. This is relative to your client, not the frontend server.
+    Example: http://homeinv.example.tld/api:3001
+### Footer details
+> REACT_APP_SUPPORT_CONTACT=
+    
+    Example: "Me"
+    Example: "admin@example.tld"
+> REACT_APP_FOOTER_IMG_URL=