From e5b165605a5227ea33cdcd333edb7ed3b128b0ae Mon Sep 17 00:00:00 2001
From: Sebastian Monroy <sebastian.monroy@gmail.com>
Date: Mon, 11 Aug 2025 13:52:32 +0100
Subject: [PATCH] update README and .env.example

---
 .env.example |  7 -------
 README.md    | 27 +++++++++++++++++++++++++++
 2 files changed, 27 insertions(+), 7 deletions(-)

diff --git a/.env.example b/.env.example
index b1b7716..1d85bad 100644
--- a/.env.example
+++ b/.env.example
@@ -1,10 +1,3 @@
-SQS_ENDPOINT_URL=http://localhost:9324
-SQS_JOBS_TO_PROCESS_QUEUE_NAME="jobs_to_process"
-AWS_ACCESS_KEY_ID=minioadmin
-AWS_SECRET_ACCESS_KEY=...
-AWS_DEFAULT_REGION=us-east-1
-COMFYUI_API_URL=
-
 # --- For media_stream.py (Output Node) ---
 # Endpoint for the SQS service where completion messages are sent.
 SQS_ENDPOINT_URL=http://localhost:9324
diff --git a/README.md b/README.md
index be1ef43..9b71950 100644
--- a/README.md
+++ b/README.md
@@ -188,4 +188,31 @@ Uploads video files to a HuggingFace dataset.
 | filename_prefix | STRING | Prefix for saved files |
 
 **Notes**: Handles batch upload of multiple video files.
+</details>
+
+## 📡 Core Nilor Services
+
+<details>
+<summary><b>Worker Consumer Service</b></summary>
+
+The `worker_consumer.py` script is a background service that runs on each ComfyUI worker. It is responsible for pulling jobs from the central ElasticMQ `jobs_to_process` queue and submitting them to its local ComfyUI instance for processing. This service is essential for the distributed architecture of the system.
+
+**Key Responsibilities:**
+-   Continuously polls the `jobs_to_process` queue for new jobs using long polling.
+-   When a job is received, it extracts the workflow data and submits it to the local ComfyUI server.
+-   Deletes the job message from the queue upon successful submission to prevent reprocessing.
+-   If submission fails, the message remains on the queue to be picked up by another worker.
+
+</details>
+
+<details>
+<summary><b>Environment Variables</b></summary>
+
+The `nilor-nodes` require a `.env` file to be present in the `ComfyUI` directory to configure the connection to the core services (MinIO, ElasticMQ, and the Brain API). To set it up, create a file named `.env` in the root of your `ComfyUI` directory by copying the `.env.example` template.
+
+**Instructions:**
+1.  Create a new file named `.env` in the `ComfyUI` directory.
+2.  Copy the contents of the `.env.example` file into your new `.env` file.
+3.  Replace the placeholder values with your actual credentials and endpoint URLs for your local or production environment.
+
 </details>
\ No newline at end of file