updates readme with changes from GH PRs

This commit is contained in:
octoshrimpy 2023-09-12 18:46:08 +02:00
parent 8cfd27407e
commit 33ffd38d46

View file

@ -3,10 +3,10 @@
### A highly customizable music and podcast downloader. ### A highly customizable music and podcast downloader.
<p align="center"> <p align="center">
<img src="https://i.imgur.com/hGXQWSl.png" width="50%"> <img src="https://i.imgur.com/hGXQWSl.png" width="50%" alt="Zotify logo">
</p> </p>
### Featues ### Features
- Downloads at up to 320kbps* - Downloads at up to 320kbps*
- Downloads directly from the source** - Downloads directly from the source**
- Downloads podcasts, playlists, liked songs, albums, artists, singles. - Downloads podcasts, playlists, liked songs, albums, artists, singles.
@ -45,7 +45,8 @@ Basic options:
-p, --playlist Downloads a saved playlist from your account -p, --playlist Downloads a saved playlist from your account
-l, --liked Downloads all the liked songs from your account -l, --liked Downloads all the liked songs from your account
-f, --followed Downloads all songs by all artists you follow -f, --followed Downloads all songs by all artists you follow
-s, --search Searches for specified track, album, artist or playlist, loads search prompt if none are given. -s, --search Searches for specified track, album, artist or playlist, loads search prompt if none are given.
-h, --help See this message.
``` ```
### Options ### Options
@ -82,7 +83,16 @@ Be aware you have to set boolean values in the commandline like this: `--downloa
| PRINT_DOWNLOADS | --print-downloads | Print messages when a song is finished downloading | PRINT_DOWNLOADS | --print-downloads | Print messages when a song is finished downloading
| TEMP_DOWNLOAD_DIR | --temp-download-dir | Download tracks to a temporary directory first | TEMP_DOWNLOAD_DIR | --temp-download-dir | Download tracks to a temporary directory first
*very-high is limited to premium only *very-high is limited to premium only
### Configuration
You can find the configuration file in following locations:
| OS | Location
|-----------------|---------------------------------------------------------|
| Windows | `C:\Users\<USERNAME>\AppData\Roaming\Zotify\config.json`|
| MacOS | `/Users/<USERNAME>/.config/zotify/config.json` |
| Linux | `/home/<USERNAME>/.config/zotify/config.json` |
### Output format ### Output format
@ -133,7 +143,7 @@ If you see this, don't worry! Just try logging back in. If you see the incorrect
Currently no user has reported their account getting banned after using Zotify. Currently no user has reported their account getting banned after using Zotify.
It is recommended you use Zotify with a burner account. It is recommended you use Zotify with a burner account.
Alternatively, there is a configuration option labled ```DOWNLOAD_REAL_TIME```, this limits the download speed to the duration of the song being downloaded thus appearing less suspicious. Alternatively, there is a configuration option labeled ```DOWNLOAD_REAL_TIME```, this limits the download speed to the duration of the song being downloaded thus appearing less suspicious.
This option is much slower and is only recommended for premium users who wish to download songs in 320kbps without buying premium on a burner account. This option is much slower and is only recommended for premium users who wish to download songs in 320kbps without buying premium on a burner account.
### Disclaimer ### Disclaimer