From 730fdf75e1674c5aa99ad49ea51a879650a0eb1b Mon Sep 17 00:00:00 2001
From: bvandeusen <bryan.vandeusen@fabledsword.com>
Date: Fri, 26 Dec 2025 09:55:00 -0500
Subject: [PATCH] making readme informative and potentially helpful to the
 public.

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d8c5be1..16bfd71 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,39 @@
 # ImageRepo
 
 This is a personal project that will be used to view store Patreon content from over the years.
-Specifically images.
+It is a viewer for images and videos and not any text content that a creator may have posted.
+
+if for some reason you want to use this repo this is a basic docker-compose.yml to run it:
+
+```
+  imagerepo:
+    image: git.fabledsword.com/bvandeusen/imagerepo:latest
+    ports:
+       - "5000:5000"
+    environment:
+   #   - DB_TYPE=postgresql
+   #   - DB_HOST=postgres
+   #   - DB_PASS=${IMAGEREPO_PASS}
+      - THUMBS_VERBOSE=1
+      - THUMBS_LOG_EVERY=1
+      - THUMBS_BATCH_SIZE=50
+    volumes:
+      - ./imagerepo/db/:/db # SQLite db storage
+      - ./imagerepo/images:/images # where the app will store it's imported images
+      - ./Patreon:/import # where it will import images from
+```
+
+by default the app will use SQLite for it's db but it can be configured with postgres
+the defaults for the postgres DB connection are:
+DB_USER = imagerepo
+DB_PASS = postgres
+DB_HOST = postgres
+DB_PORT = 5432
+DB_NAME = imagerepo
+
+the above are also environment variables that can be set in the docker-compose
+
+# Imports
+the app checks the "/import" directory either when triggered from the settings menu or every 8 hours.
+
+the importer assumes that folders in the root of the import directory indicate the artist the images are from and tags the imports with the directory as a name. I have not tested with images sitting in the root as I don't have my files structured like that.
\ No newline at end of file