From 35ff6c5dccdde30e37e4b9ab2dacbc5bc8c19f06 Mon Sep 17 00:00:00 2001
From: zebra <me@izebra.xyz>
Date: Mon, 9 Jun 2025 17:09:28 -0700
Subject: [PATCH] updated README

---
 README.md | 89 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 60 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 661c80d..10d8639 100644
--- a/README.md
+++ b/README.md
@@ -26,79 +26,110 @@ The downloaded track is organized into your Lidarr media folder or a YouTube sub
 - Python 3.6+
 - `requests`
 
-You can install the required Python packages using:
+Install Python dependencies:
 
 ```bash
 pip install requests
 ```
-📼 External Tools
 
-    yt-dlp: YouTube downloader for audio/video.
+### 📼 External Tools
+
+- `yt-dlp`: YouTube downloader for audio/video.
 
 Install via pip (recommended):
+
 ```bash
 pip install -U yt-dlp
 ```
-Or install system-wide:
-```bash
-sudo apt install yt-dlp  # On Debian/Ubuntu
-```
-⚙️ Configuration
 
-Lidarr Setup
-Ensure Lidarr is running and accessible (e.g., http://localhost:8686).
-Create or retrieve your API key from Lidarr's settings.
-    
-Environment Variable    Set your API key in the terminal session:
+Or install system-wide (Debian/Ubuntu):
+
+```bash
+sudo apt install yt-dlp
 ```
+
+---
+
+## ⚙️ Configuration
+
+### Lidarr Setup
+
+- Ensure Lidarr is running and accessible (e.g., [http://localhost:8686](http://localhost:8686)).
+- Create or retrieve your API key from Lidarr's settings.
+
+Set your API key in the terminal session:
+
+```bash
 export LIDARR_API_KEY="your-lidarr-api-key"
 ```
+
 Or run inline:
+
 ```bash
-    LIDARR_API_KEY="your-lidarr-api-key" ./musicfetch "Artist - Track"
+LIDARR_API_KEY="your-lidarr-api-key" ./musicfetch "Artist - Track"
 ```
-🧑‍💻 Usage
-🔉 Download by Search Term
+
+---
+
+## 🧑‍💻 Usage
+
+### 🔉 Download by Search Term
+
 ```bash
 ./musicfetch "Artist - Track"
 ```
+
 Example:
+
 ```bash
 ./musicfetch "ODESZA - Bloom"
 ```
+
 If Lidarr finds the artist and album, it will trigger a download in Lidarr. If not, the song will be downloaded via yt-dlp using a YouTube search.
-📺 Download by URL
+
+### 📺 Download by URL
+
 ```bash
 ./musicfetch "https://www.youtube.com/watch?v=xxxxxxxxxxx"
 ```
+
 The script extracts metadata from the video and organizes the file under the artist's folder.
-📁 Output Structure
+
+### 📁 Output Structure
 
 Music is saved in:
-```
+
+```text
 /base_dir/
 ├── Artist Name/
 │   ├── Album Name/   (if found via Lidarr)
 │   └── youtube/      (if fallback used)
 ```
-❓ Troubleshooting
 
-    No results from Lidarr -
-    Check to make sure your Lidarr installation is reachable and the artist exists or can be found in Lidarr's metadata sources.
+---
 
-    yt-dlp errors -
-    Try updating it:
+## ❓ Troubleshooting
 
+- **No results from Lidarr:**
+  - Check to make sure your Lidarr installation is reachable and the artist exists or can be found in Lidarr's metadata sources.
+- **yt-dlp errors:**
+  - Try updating it:
+
+    ```bash
     yt-dlp -U
+    ```
 
-    Permission denied or file not found?
-    Ensure /media/music exists and is writable.
+- **Permission denied or file not found?**
+  - Ensure `/media/music` exists and is writable.
 
-🛠️ Contributing
+---
 
-PRs are welcome, I only ask that you make the changes easy to follow. This script is designed to act as middleware, and not a replacement or plugin for Lidarr. The changes must also be compatible with Bash-based workflows.
+## 🛠️ Contributing
 
+PRs are welcome! Please make your changes easy to follow. This script is designed to act as middleware, not a replacement or plugin for Lidarr. Changes must also be compatible with Bash-based workflows.
 
-📜 License
+---
+
+## 📜 License
 
 MIT – Use it freely and improve it as you wish!