From a7adb7b8eb7d74957093246613eeeb728b8966f5 Mon Sep 17 00:00:00 2001 From: Guillem Castro Date: Sat, 11 May 2024 13:08:07 +0200 Subject: [PATCH] update README --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 39 +++++++++++++++++++++++++++++++++------ 3 files changed, 35 insertions(+), 8 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 51c65d2..8950120 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2303,7 +2303,7 @@ dependencies = [ [[package]] name = "spotify-dl" -version = "0.2.0" +version = "0.2.1" dependencies = [ "anyhow", "async-trait", diff --git a/Cargo.toml b/Cargo.toml index 2916355..6a30984 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "spotify-dl" -version = "0.2.0" +version = "0.2.1" authors = ["Guillem Castro "] edition = "2021" readme = "README.md" diff --git a/README.md b/README.md index 92370eb..8f44eb4 100644 --- a/README.md +++ b/README.md @@ -25,30 +25,57 @@ sudo dnf install flac-devel alsa-lib-devel brew install flac ``` +## Installation + +Before installation, make sure all dependencies are installed for your platform. + +### Using `cargo` + +``` +cargo install spotify-dl +``` + +### Using homebrew + +``` +brew tap guillemcastro/spotify-dl +brew install spotify-dl +``` + +### From source + +``` +git clone https://github.com/GuillemCastro/spotify-dl.git +cd spotify-dl +cargo build --release +cargo install --path . +``` + ## Usage ``` -spotify-dl 0.1.1 +spotify-dl 0.2.0 A commandline utility to download music directly from Spotify USAGE: - spotify-dl [FLAGS] [OPTIONS] --username [tracks]... + spotify-dl [OPTIONS] ... --username FLAGS: -h, --help Prints help information - -o, --ordered Prefixing the filename with its index in the playlist -V, --version Prints version information OPTIONS: -c, --compression Setting the flac compression level from 0 (fastest, least compression) to 8 (slowest, most compression). A value larger than 8 will be Treated as 8. Default is 4. - -d, --destination The directory where the songs will be downloaded [default: .] + -d, --destination The directory where the songs will be downloaded + -t, --parallel Number of parallel downloads. Default is 5. [default: 5] -p, --password Your Spotify password -u, --username Your Spotify username ARGS: - ... A list of Spotify URIs (songs, podcasts or playlists)``` + ... A list of Spotify URIs or URLs (songs, podcasts, playlists or albums) +``` Songs, playlists and albums must be passed as Spotify URIs or URLs (e.g. `spotify:track:123456789abcdefghABCDEF` for songs and `spotify:playlist:123456789abcdefghABCDEF` for playlists or `https://open.spotify.com/playlist/123456789abcdefghABCDEF?si=1234567890`). @@ -58,4 +85,4 @@ The usage of this software may infringe Spotify's ToS and/or your local legislat ## License -spotify-dl is lic:ewensed under the MIT license. See [LICENSE](LICENSE). +spotify-dl is licensed under the MIT license. See [LICENSE](LICENSE).