diff --git a/README.MD b/README.MD index cb0869a..89b6a22 100644 --- a/README.MD +++ b/README.MD @@ -1,45 +1,47 @@ # Bash Music sync -(c) 2018-2019 Jeroen De Meerleer +(c) 2018-2020 Jeroen De Meerleer Script to sync music from one folder to another ## Usage: ``` -music-sync -s|--source -d|--dest -music-sync + Syncronises music from one folder to another. -Syncronises music from one folder to another. + Usage: + music-sync -s|--source -d|--dest + music-sync -Options: - -s, --source The source folder of the music - -d, --dest The destination folder of the music - -t, --temp The temporary cache for converted files (default: /tmp/converted) - -c, --convert Convert files to a given bitrate in kbps before syncing (default: 192) - -a, --resize-art Resize album-art before syncing (default width: 200) - -v, --verbose <0-6> Set log level (default: 2) - -h, --help Display this help text + Options: + -s, --source The source folder of the music + -d, --dest The destination folder of the music + -t, --temp The temporary cache for converted files (default: /tmp/converted) + -c, --convert Convert files to a given bitrate in kbps before syncing (default: 192) + -a, --resize-art Resize album-art before syncing (default width: 200) + -j, --jobs Number of processes to use in multi-threading (default: CPU_CORES - 2) + -v, --verbose <0-6> Set log level (default: 2) + -h, --help Display this help text -Log levels: - 0 | Verbose - 1 | Debug - 2 | Info - 3 | Warning - 4 | Error - 5 | Fatal - 6 | Silence + Log levels: + 0 | Verbose + 1 | Debug + 2 | Info + 3 | Warning + 4 | Error + 5 | Fatal + 6 | Silence -Exit Codes: - 1 Dependencies not met - 2 Invalid Argument - 3 Source Unreachable - 4 Destination Unreachable - 5 Command failed + Exit Codes: + 1 Dependencies not met + 2 Invalid Argument + 3 Source Unreachable + 4 Destination Unreachable + 5 Command failed ``` ## Licence -Copyright 2018-2019 Jeroen De Meerleer +Copyright 2018-2020 Jeroen De Meerleer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: