From ac7826e5f1a317de3c2dfd6489caa8f9ae147ff2 Mon Sep 17 00:00:00 2001 From: Dominic Pearson Date: Sat, 17 Aug 2024 19:10:45 +0200 Subject: [PATCH] correct markdown formatting --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index aebee38..ac0a99a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -librespot-auth -============== +# librespot-auth A simple program for populating a `credentials.json` via Spotify's zeroconf authentication. -Optional arguments: - --name Name of the virtual speaker, default: "Speaker" - --path Target path for credentials, default: "credentials.json" relative to execution +## Optional Arguments -While running on the same network as a Spotify client, it should appear as a Spotify Connect device with the given name. Select it once as an output device, and the Spotify client will transmit the required authentication blob, which is received by this application, written to the credentials path, and immediately exits. This is useful in cases where you run librespot on remote hosts on a different network (thus complicating zeroconf), as in version 3.203.235 of the Spotify eSDK they removed the SpConnectionLoginPassword API. +- `--name`: Name of the virtual speaker (default: "Speaker"). +- `--path`: Target path for credentials (default: `credentials.json` relative to execution). + +## How It Works + +While running on the same network as a Spotify client, it should appear as a Spotify Connect device with the given name. Select it once as an output device, and the Spotify client will transmit the required authentication blob. This blob is received by this application, written to the specified credentials path, and the application immediately exits. + +This process is useful in cases where you run librespot on remote hosts on a different network (thus complicating zeroconf). As of version 3.203.235 of the Spotify eSDK, the `SpConnectionLoginPassword` API has been removed.