From 1ea58a873b62e3e74a2d4d1a9e7bdf66b6887e1b Mon Sep 17 00:00:00 2001
From: Jan Barfuss <janbar2001@gmail.com>
Date: Thu, 26 Dec 2024 00:09:36 +0100
Subject: [PATCH] UPDATED README.me

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

diff --git a/README.md b/README.md
index 19fbd4f..927a89d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,18 @@
-# Bookholder-API
\ No newline at end of file
+# Bookholder-API
+
+## Setup
+For this project a PostgreSQL database is required.
+
+### Enviroment Vars
+```
+DB_USER = user
+DB_PASSWORRD = password
+DB_HOST = my.host
+DB_PORT = 5432
+DB_NAME = databasename # Optinal; bookholder is the default
+SECRET = your32charactersecret
+PORT = 8080 # Optional; 8080 is the default port
+```
+### Example
+
+Examples are found in the examples folder.
\ No newline at end of file