diff --git a/README.md b/README.md index 60bb487..1df23da 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -# slsk-batchdl \ No newline at end of file +# slsk-batchdl + +A barely-functional batch downloader for Soulseek. Accepts csv files. + +``` +Usage: slsk-batchdl.exe [OPTIONS] +Options: + --output Downloaded files will be placed here + --csv The csv file containing track information (in case it's not in the output folder) + --username Soulseek username + --password Soulseek password + --artist-col Specify if the csv file contains an artist name column + --track-col Specify if if the csv file contains an track name column + --full-title-col Specify only if there are no separate artist and track name columns are not in the csv + --uploader-col Specify when using full title col if there is also an uploader col in the csv (fallback in case artist name cannot be extracted from title) + --length-col Specify the name of the track duration column, if exists + --time-unit Time unit for the track duration column, ms or s (default: s) + --skip-existing Skip if a track matching the conditions is found in the output folder or your music library (if provided) (default: false) + --skip-if-pref-failed Skip if preferred versions of a track exist but failed to download. If no pref. versions were found, download as normal. (default: false) + --create-m3u Create an m3u playlist file in the output dir. (default: false) + --search-timeout Maximal search time (default: 15000) + --download-max-stale-time