From f0bed2783e88d95846662c4889c2e04b5c8f7324 Mon Sep 17 00:00:00 2001
From: Jack Case <jackacase@gmail.com>
Date: Mon, 27 Oct 2025 14:35:31 -0400
Subject: [PATCH] add info to README

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1cda843..ce99070 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,11 @@
-# slop-farmer-server
\ No newline at end of file
+# slop-farmer-server
+FastAPI-based server to form the backend of the Slop Farmer browser extension.
+Handles user authentication, requests to check search result URLs against reported slop,
+and new reports of slop URLs from users.
+
+## Docker Container
+run the server with `docker run -P --env-file <env file> slopfarmer`
+
+## Environment Variables
+DB_URL - The url connection string to pass to SQLAlchemy
+TOKEN_SECRET - the secret used for signing JWTs used for user auth after login