From 640da79afac8872b2a46501b80f83faac4162389 Mon Sep 17 00:00:00 2001
From: shadowalker125 <16189570+Shadowalker125@users.noreply.github.com>
Date: Tue, 18 Feb 2025 21:57:37 -0600
Subject: [PATCH] updated README.md

---
 README.md | 52 +++++++++++++++++++++++++++++-----------------------
 1 file changed, 29 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index df81b2a..9291d73 100644
--- a/README.md
+++ b/README.md
@@ -19,44 +19,50 @@ This allows, for example, someone to then point Lidarr to the URL using the cust
 
 ## Installation
 
-At the moment, this isnt containerized and requires node.js
-
-Follow Run locally below, then add the URL to lidarr under Settings>Import Lists>Custom List
+### unRaid community apps
+*soon*
+
+### docker-compose
+
+```yaml
+services:
+  server:
+    image: ghcr.io/shadowalker125/recommendarr:latest
+    container_name: recommendarr
+    environment:
+      PUID: 1000
+      PGID: 1000
+      NODE_ENV: production
+      USERS: ""
+      LISTS: ""
+    ports:
+      - "4500:4500"
+```
 
 
 ## Environment Variables
 
 To run this project, you will need to update the following environment variables to your .env file
 
-`USER`
-
-`LISTS`
-
-
-## Run Locally
+Users is an array of any Listenbrainz usernames: 
 
-Clone the project
+`USERS`
 
-```bash
-  git clone https://github.com/Shadowalker125/recommendarr.git
-```
+Lists is any of the created lists in listenbrainz. "weekly-exploration" is the recommended one
 
-Install dependencies
+`LISTS`
 
-```bash
-  npm install
-```
+## Usage/Examples
 
-Start the server
+To use with Lidarr, open Settings > Import Lists > Add List > Custom List
 
-```bash
-  npm run start
-```
+Change settings to your liking regarding monitoring, quality profile, etc...
 
+For the List URL, simply add the url and port '4500' for the running instance of recommendarr 
 
-## Usage/Examples
+ex: 'http://localhost:4500'
 
-spits out JSON object on localhost:4500
+spits out JSON object
 
 ```json
 [{"MusicBrainzId":"41656317-c512-456f-9fe7-1f7fb8482a34"},