From b1e8dcd535d90a703c3edcdf3756b14d082e33bb Mon Sep 17 00:00:00 2001
From: fiso64 <sokfilix@gmail.com>
Date: Sat, 5 Oct 2024 11:40:13 +0200
Subject: [PATCH] readme

---
 README.md            | 88 ++++++++++++++++++++++----------------------
 slsk-batchdl/Help.cs | 16 ++++----
 2 files changed, 52 insertions(+), 52 deletions(-)

diff --git a/README.md b/README.md
index 64fcb64..c87b8bb 100644
--- a/README.md
+++ b/README.md
@@ -41,51 +41,51 @@ Usage: sldl <input> [OPTIONS]
 ```
 ```
   General Options
-    -p, --path <path>              Download directory
-    --input-type <type>            [csv|youtube|spotify|bandcamp|string|list]
-    --name-format <format>         Name format for downloaded tracks. See --help name-format
-        
-    -n, --number <maxtracks>       Download the first n tracks of a playlist
-    -o, --offset <offset>          Skip a specified number of tracks
-    -r, --reverse                  Download tracks in reverse order
-    -c, --config <path>            Set config file location. Set to 'none' to ignore config
-    --profile <names>              Configuration profile(s) to use. See --help ""config"".
-    --concurrent-downloads <num>   Max concurrent downloads (default: 2)
-    --m3u <option>                 Create an m3u8 playlist file in the output directory
-                                   'none' (default for string inputs): Do not create 
-                                   'index' (default): Write a single line for sldl to index 
-                                   all downloaded files, required for skip-existing=m3u
-                                   'all': Write the index and a list of paths and fails
-    --m3u-path <path>              Override default m3u path
-        
-    -s, --skip-existing            Skip if a track matching file conditions is found in the
-                                   output folder or your music library (if provided)
-    --skip-mode <mode>             [name|tag|m3u|name-cond|tag-cond|m3u-cond]
-                                   See --help ""skip-existing"".
-    --music-dir <path>             Specify to also skip downloading tracks found in a music
-                                   library. Use with --skip-existing
-    --skip-not-found               Skip searching for tracks that weren't found on Soulseek
-                                   during the last run. Fails are read from the m3u file.
-    --skip-existing-pref-cond      Use preferred instead of necessary conds for skip-existing    
-        
-    --listen-port <port>           Port for incoming connections (default: 49998)
-    --on-complete <command>        Run a command whenever a file is downloaded.
-                                   Available placeholders: {path} (local save path), {title},
-                                   {artist},{album},{uri},{length},{failure-reason},{state}.
-                                   Prepend a state number to only download in specific cases:
-                                   1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and
-                                   NotFoundLastTime states respectively. 
-                                   E.g: '1:<cmd>' will only run the command if the file is
-                                   downloaded successfully. Prepend 's:' to use the system
-                                   shell to execute the command.
+	-p, --path <path>              Download directory
+	--input-type <type>            [csv|youtube|spotify|bandcamp|string|list]
+	--name-format <format>         Name format for downloaded tracks. See --help name-format
+	  
+	-n, --number <maxtracks>       Download the first n tracks of a playlist
+	-o, --offset <offset>          Skip a specified number of tracks
+	-r, --reverse                  Download tracks in reverse order
+	-c, --config <path>            Set config file location. Set to 'none' to ignore config
+	--profile <names>              Configuration profile(s) to use. See --help ""config"".
+	--concurrent-downloads <num>   Max concurrent downloads (default: 2)
+	--m3u <option>                 Create an m3u playlist file in the output directory
+								   'none' (default for string inputs): Do not create 
+								   'index'(default): Write a single line for sldl to index 
+								   downloaded files. Required for skip-existing=m3u.
+								   'all': Create a playable m3u playlist file and sldl index.
+	--m3u-path <path>              Override default m3u path
+		
+	-s, --skip-existing            Skip if a track matching file conditions is found in the
+								   output folder or your music library (if provided)
+	--skip-mode <mode>             [name|tag|m3u|name-cond|tag-cond|m3u-cond]. See --help
+								   skip-existing.
+	--music-dir <path>             Specify to also skip downloading tracks found in a music
+								   library. Use with --skip-existing
+	--skip-not-found               Skip searching for tracks that weren't found on Soulseek
+								   during the last run. Fails are read from the m3u file.
+	--skip-existing-pref-cond      Use preferred instead of necessary conds for skip-existing    
+	  
+	--listen-port <port>           Port for incoming connections (default: 49998)
+	--on-complete <command>        Run a command whenever a file is downloaded.
+								   Available placeholders: {path} (local save path), {title},
+								   {artist},{album},{uri},{length},{failure-reason},{state}.
+								   Prepend a state number to only run in specific cases:
+								   1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and
+								   NotFoundLastTime states respectively. 
+								   E.g: '1:<cmd>' will only run the command if the file is
+								   downloaded successfully. Prepend 's:' to use the system
+								   shell to execute the command.
 
-    --print <option>               Print tracks or search results instead of downloading:
-                                   'tracks': Print all tracks to be downloaded
-                                   'tracks-full': Print extended information about all tracks
-                                   'results': Print search results satisfying file conditions
-                                   'results-full': Print search results including full paths
-    --no-progress                  Disable progress bars/percentages, only simple printing
-    --debug                        Print extra debug info
+	--print <option>               Print tracks or search results instead of downloading:
+								   'tracks': Print all tracks to be downloaded
+								   'tracks-full': Print extended information about all tracks
+								   'results': Print search results satisfying file conditions
+								   'results-full': Print search results including full paths.
+	--no-progress                  Disable progress bars/percentages, only simple printing
+	--debug                        Print extra debug info
 ```
 ```
   Searching
diff --git a/slsk-batchdl/Help.cs b/slsk-batchdl/Help.cs
index 76efac5..759f601 100644
--- a/slsk-batchdl/Help.cs
+++ b/slsk-batchdl/Help.cs
@@ -28,17 +28,17 @@ public static class Help
         -c, --config <path>            Set config file location. Set to 'none' to ignore config
         --profile <names>              Configuration profile(s) to use. See --help ""config"".
         --concurrent-downloads <num>   Max concurrent downloads (default: 2)
-        --m3u <option>                 Create an m3u8 playlist file in the output directory
+        --m3u <option>                 Create an m3u playlist file in the output directory
                                        'none' (default for string inputs): Do not create 
-                                       'index' (default): Write a single line for sldl to index 
-                                       all downloaded files, required for skip-existing=m3u
-                                       'all': Write the index and a list of paths and fails
+                                       'index'(default): Write a single line for sldl to index 
+                                       downloaded files. Required for skip-existing=m3u.
+                                       'all': Create a playable m3u playlist file and sldl index.
         --m3u-path <path>              Override default m3u path
             
         -s, --skip-existing            Skip if a track matching file conditions is found in the
                                        output folder or your music library (if provided)
-        --skip-mode <mode>             [name|tag|m3u|name-cond|tag-cond|m3u-cond]
-                                       See --help ""skip-existing"".
+        --skip-mode <mode>             [name|tag|m3u|name-cond|tag-cond|m3u-cond]. See --help
+                                       skip-existing.
         --music-dir <path>             Specify to also skip downloading tracks found in a music
                                        library. Use with --skip-existing
         --skip-not-found               Skip searching for tracks that weren't found on Soulseek
@@ -49,7 +49,7 @@ public static class Help
         --on-complete <command>        Run a command whenever a file is downloaded.
                                        Available placeholders: {path} (local save path), {title},
                                        {artist},{album},{uri},{length},{failure-reason},{state}.
-                                       Prepend a state number to only download in specific cases:
+                                       Prepend a state number to only run in specific cases:
                                        1:, 2:, 3:, 4: for the Downloaded, Failed, Exists, and
                                        NotFoundLastTime states respectively. 
                                        E.g: '1:<cmd>' will only run the command if the file is
@@ -60,7 +60,7 @@ public static class Help
                                        'tracks': Print all tracks to be downloaded
                                        'tracks-full': Print extended information about all tracks
                                        'results': Print search results satisfying file conditions
-                                       'results-full': Print search results including full paths
+                                       'results-full': Print search results including full paths.
         --no-progress                  Disable progress bars/percentages, only simple printing
         --debug                        Print extra debug info