Update 'README.md'

README.md

@@ -1,71 +1,74 @@
-## Overview
-**SM-AU** is a tool for automating the uploading process on SugoiMusic.eu. It requires python 3.8.  
-
-
-**Features:**
-- SM Client.
-- FTP Support
-- FLAC/MP3 Support.
-- Detection of 24bit FLAC
-
-**Installation:**
-- Install requirements
-```
-pip install -r requirements.txt
-```
-
-## Command Usage
-```
-python autoupload.py {command_name} {ID/URL}
-```
-Command  | Description  | Example
--d, --debug | Provides additional information on upload for debugging purposes | `python autoupload.py -d`
--t, --tags | Add additional tags to upload, separated with comma. Minimum 2 tags required. | `python autoupload.py -t "korean, female.vocalist" -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"`
--dir, --directory | Appoint directory used for torrent creation | `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"`
--dry, --dryrun | Carries out all actions other than the upload itself.| `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]" -dry`
--im, --imageURL | Set the torrent cover URL | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3] -i "https://someimageurl.com/someimage.jpg""`
--tdes [TORRENTDESCRIPTION], --description [TORRENTDESCRIPTION] | Add a torrent description. Only available as an argument.
-
-
-## Config.json  
-
-- Make a copy of the Config.json.example and rename it Config.json. Edit the Config.json as desired.
-- It's not recommended to use both local watch/download folders and ftp watch/download folders at the same time as it will result in seeding from 2 locations.
-- Please make sure your password does not contain any special characters.
-- For the directory paths in the config please use the forward slash "/"
-
-**credentials:**
-
-Config  | Description  | Example
-Username | SugoiMusic Username | User234
-Password  | SugoiMusic Password | Password
-Passkey  | SugoiMusic Passkey | Passkey
-
-**local_prefs**  
-
-Config  | Description  | Example
-add_to_watch_folder | moves .torrent file to local watch folder | `true/false`  
-add_to_downloads_folder | moves torrent data to local downloads folder | `true/false`  
-local_watch_folder | directory of local watch folder | `Z:/watch/Transmission`
-local_downloads_folder | directory of local downloads folder | `Z:/downloads`  
-
-
-**ftp_prefs:**
-
-Config  | Description  | Example
-enable_ftp  | enable ftp mode, if enabled suggested to disable local watch and downloads folders | `true/false`
-add_to_watch_folder | transfer .torrent file to watch folder on FTP server | `true/false`
-add_to_downloads_folder | transfer torrent data to downloads folder on FTP server | `true/false`
-ftp_server | url of ftp server | haze.seedhost.eu
-ftp_username | username of ftp account | slyy
-ftp_password | password of ftp account | password
-ftp_watch_folder | directory of ftp watch folder | `/downloads/watch/transmission`
-ftp_downloads_folder | directory of ftp downloads folder | `/downloads`
-
-
-## Disclaimer
-- The usage of this script **may be** illegal in your country. It's your own responsibility to inform yourself of Copyright Law.
+## Overview
+**SM-AU** is a tool for automating the uploading process on SugoiMusic.eu. It requires python 3.8.  
+
+Warning: if your files aren’t tagged nicely it can mess up the generation of the tracklist for the torrent group description.
+
+Use the copycommand.txt file to easily build the commands for each upload.
+
+**Features:**
+- SM Client.
+- FTP Support
+- FLAC/MP3 Support.
+- Detection of 24bit FLAC
+
+**Installation:**
+- Install requirements
+```
+pip install -r requirements.txt
+```
+
+## Command Usage
+```
+python autoupload.py {command_name} {ID/URL}
+```
+Command  | Description  | Example
+------------- | ------------- | -------------
+-d, --debug | Provides additional information on upload for debugging purposes | `python autoupload.py -d`
+-t, --tags | Add additional tags to upload, separated with comma. Minimum 2 tags required. | `python autoupload.py -t "korean, female.vocalist" -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"`
+-dir, --directory | Appoint directory used for torrent creation | `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"`
+-dry, --dryrun | Carries out all actions other than the upload itself.| `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]" -dry`
+-im, --imageURL | Set the torrent cover URL | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3] -i "https://someimageurl.com/someimage.jpg""`
+-tdes [TORRENTDESCRIPTION], --description [TORRENTDESCRIPTION] | Add a torrent description. Only available as an argument.
+
+
+## Config.json  
+
+- Make a copy of the Config.json.example and rename it Config.json. Edit the Config.json as desired.
+- It's not recommended to use both local watch/download folders and ftp watch/download folders at the same time as it will result in seeding from 2 locations.
+- Please make sure your password does not contain any special characters.
+- For the directory paths in the config please use the forward slash "/"
+
+**credentials:**
+
+Config  | Description  | Example
+------------- | ------------- | -------------
+Username | SugoiMusic Username | User234
+Password  | SugoiMusic Password | Password
+Passkey  | SugoiMusic Passkey | Passkey
+
+**local_prefs**  
+
+Config  | Description  | Example
+------------- | ------------- | -------------
+add_to_watch_folder | moves .torrent file to local watch folder | `true/false`  
+add_to_downloads_folder | moves torrent data to local downloads folder | `true/false`  
+local_watch_folder | directory of local watch folder | `Z:/watch/Transmission`
+local_downloads_folder | directory of local downloads folder | `Z:/downloads`  
+
+
+**ftp_prefs:**
+
+Config  | Description  | Example
+------------- | ------------- | -------------
+enable_ftp  | enable ftp mode, if enabled suggested to disable local watch and downloads folders | `true/false`
+add_to_watch_folder | transfer .torrent file to watch folder on FTP server | `true/false`
+add_to_downloads_folder | transfer torrent data to downloads folder on FTP server | `true/false`
+ftp_server | url of ftp server | haze.seedhost.eu
+ftp_username | username of ftp account | slyy
+ftp_password | password of ftp account | password
+ftp_watch_folder | directory of ftp watch folder | `/downloads/watch/transmission`
+ftp_downloads_folder | directory of ftp downloads folder | `/downloads`
+
+
+## Disclaimer
+- The usage of this script **may be** illegal in your country. It's your own responsibility to inform yourself of Copyright Law.