From bc5c57148821c06583bf4dd64504ef3687142cda Mon Sep 17 00:00:00 2001 From: Xevion Date: Tue, 1 Oct 2024 18:56:15 -0500 Subject: [PATCH] Update README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 24e56bb..1ad0903 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # spotify-player-quickauth -A simple CLI-based application for creating a `credentials.json` file, used by the [spotify-player][spotify-player] library, for authenticating with the Spotify API. \ No newline at end of file +A simple CLI-based application for creating a `credentials.json` file, used by the [spotify-player][spotify-player] library, for authenticating with the Spotify API. + +## Usage + +You can install this applicaiton, but most people will just need it once. + +```bash +curl -sSL https://raw.githubusercontent.com/Xevion/spotify-player-quickauth/refs/heads/master/run.sh | sh +``` + +## Building from Source + +Don't want to run my funky shell script? No problem! You can build the application from source easily. + +```bash +git clone https://github.com/Xevion/spotify-player-quickauth.git +cd spotify-player-quickauth +cargo build --release +./target/release/spotify-player-quickauth +``` + +[spotify-player]: https://github.com/aome510/spotify-player \ No newline at end of file