From 942dd102ebd52db1909ad7ec7f65eeccf4924d38 Mon Sep 17 00:00:00 2001
From: dylan-fournier <124598538+dylan-fournier@users.noreply.github.com>
Date: Fri, 24 May 2024 12:52:41 -0400
Subject: [PATCH] Talked about settings

---
 readme.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index 7c3ca6f..b3affca 100644
--- a/readme.md
+++ b/readme.md
@@ -8,7 +8,7 @@ This was created for a personal use case for parties, and is a simple, (mostly)
 The client is a web application that can be hosted on any server, it need not be the same device running the music player. 
 * If the app is being setup for a large group, you can distribute the url (via QR code, for example) with `?ip=YOURSERVERHOSTNAME:19054` set as an attribute after the url. 
 ### Server Setup:
-**Pre-setup:** If you want the songs to have art associated with them, it is all hosted on and retrieved from LastFM, and you will need to sign up for a developer app, and put your key \
+**Pre-setup:** If you want the songs to have art associated with them, it is all hosted on and retrieved from LastFM, and you will need to sign up for a developer app, and put your key in the database generator \
 \
 The server side consists of 3 files
 
@@ -19,7 +19,7 @@ webbyBits.py
 ```
 
 1. Place mp3 files in the `sound/` folder
-2. Open `databaseGenerator.py` and put your lastFM API key in at the top (*optional*)
+2. Open `databaseGenerator.py` and put your LastFM API key in at the top (*optional*)
 3. Run `databaseGenerator.py`
     * *The `databaseGenerator.py` will index all mp3 files, and save the information to `songDatabase.json`*
     * *If getting images, this process may take a long time with a large amount of mp3 files*
@@ -34,6 +34,7 @@ These are specific details on each section of the app, and how to use them
 - `databaseGenerator.py` scans through mp3 files and gets information about them
     - `Filename, Title, Artist, Art, Length` are all saved 
         - *If the title and artist are not in the mp3 metadata, it looks for a format of* `TITLE_ARTIST.mp3` *and otherwise defaults to the file name as the title, and no artist*
+        - Art is retrieved from LastFM
     - Running with `--mode (update/new)` either updates the current database and only adds new songs, or recreates the entire database (update is default)
     - Running with `--art (True/False)` retrieves art from  LastFM or doesn't (True is default)
 - `songDatabase.json` stores all the information about each song in this format:
@@ -60,4 +61,9 @@ From left to right:
 - The skip button goes to the next track
 - The search button opens the search screen (pictured)
 - The settings button (top right) opens the settings menu
+    - Server IP allows you to change the ip that the site connects to
+    - Alert time changes how long error/confirmation messages are shown for (Default 2)
+    - Party Mode adds new songs to the queue when the queue has only 1 song in it
+    - 
+