From 2b76fa9e6f39d16a7fad992de1fc9b5c4929e864 Mon Sep 17 00:00:00 2001 From: Josh Patra Date: Mon, 9 Feb 2026 14:54:43 -0500 Subject: [PATCH] Enhance README with features and images Updated README.md to enhance feature descriptions and add images. --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 82f82ca..a432515 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,8 @@ The proxy will be available at `http://localhost:5274`. ## Web Dashboard Allstarr includes a web UI for easy configuration and playlist management, accessible at `http://localhost:5275` +image + ### Features @@ -74,8 +76,6 @@ There's an environment variable to modify this. **Recommended workflow**: Use the `sp_dc` cookie method alongside the [Spotify Import Plugin](https://github.com/Viperinius/jellyfin-plugin-spotify-import?tab=readme-ov-file). - - ### Nginx Proxy Setup (Required) This service only exposes ports internally. You can use nginx to proxy to it, however PLEASE take significant precautions before exposing this! Everyone decides their own level of risk, but this is currently untested, potentially dangerous software, with almost unfettered access to your Jellyfin server. My recommendation is use Tailscale or something similar! @@ -139,8 +139,14 @@ This project brings together all the music streaming providers into one unified **Compatible Jellyfin clients:** - [Feishin](https://github.com/jeffvli/feishin) (Mac/Windows/Linux) -- [Musiver](https://music.aqzscn.cn/en/) (Android/IOS/Windows/Android) -- [Finamp](https://github.com/jmshrv/finamp) () +image + + +- [Musiver](https://music.aqzscn.cn/en/) (Android/iOS/Windows/Android) +image + + +- [Finamp](https://github.com/jmshrv/finamp) (Android/iOS) _Working on getting more currently_ @@ -336,6 +342,9 @@ Subsonic__EnableExternalPlaylists=false Allstarr automatically fills your Spotify playlists (like Release Radar and Discover Weekly) with tracks from your configured streaming provider (SquidWTF, Deezer, or Qobuz). This works by intercepting playlists created by the Jellyfin Spotify Import plugin and matching missing tracks with your streaming service. +image + + #### Prerequisites 1. **Install the Jellyfin Spotify Import Plugin** @@ -914,4 +923,4 @@ GPL-3.0 - [Deezer](https://www.deezer.com/) - Music streaming service - [Qobuz](https://www.qobuz.com/) - Hi-Res music streaming service - [spotify-lyrics-api](https://github.com/akashrchandran/spotify-lyrics-api) - Thank them for the fact that we have access to Spotify's lyrics! -- [LRCLIB](https://github.com/tranxuanthang/lrclib) - The GOATS for giving us a free api for lyrics! They power LRCGET, which I'm sure some of you have heard of \ No newline at end of file +- [LRCLIB](https://github.com/tranxuanthang/lrclib) - The GOATS for giving us a free api for lyrics! They power LRCGET, which I'm sure some of you have heard of