From 582870194485f949a79e15e95d95172d151b8480 Mon Sep 17 00:00:00 2001 From: Nathan Hoffman <46334485+BadCoder2@users.noreply.github.com> Date: Tue, 25 Feb 2025 23:44:26 -0600 Subject: [PATCH] Update README.md to uv; make environment setting more clear --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a52204..3950e09 100644 --- a/README.md +++ b/README.md @@ -48,20 +48,14 @@ Full list of configuration options can be found in the [.env.sample](.env.sample ### Baremetal -- Setup virtualenv of your choice +- [Install uv](https://docs.astral.sh/uv/getting-started/installation/) -- Install dependencies - - ```bash - pip install -r requirements.txt - ``` - -- Create a .env file similar to .env.sample, uncomment whitelist and blacklist if needed, fill in baseurls and tokens +- Create a .env file similar to .env.sample; fill in baseurls and tokens, **remember to uncomment anything you wish to use** (e.g., user mapping, library mapping, black/whitelist, etc.) - Run ```bash - python main.py + uv run main.py ``` ### Docker @@ -104,6 +98,7 @@ Full list of configuration options can be found in the [.env.sample](.env.sample - Configuration - Do not use quotes around variables in docker compose + - If you are not running all 3 supported servers, that is, Plex, Jellyfin, and Emby simultaneously, make sure to comment out the server url and token of the server you aren't using. ## Contributing