Zip release files in maven package

README.md

@@ -2,11 +2,12 @@
  - Introduction
  - Requirements
  - Running
- - config.yml example
+ - Configuration
+ - Additional parameters
  
 ### Introduction
 
-This program helps changing audio and subtitle lines of mkv files.
+This program helps to change audio and subtitle lines of mkv files.
 
 ### Requirements
 
@@ -15,32 +16,22 @@ This program helps changing audio and subtitle lines of mkv files.
  
 ### Running
 
-Opening terminal / cmd in the directory of the jar and the config file and execute following command:
+1. Extract downloaded archive
+2. Copy `config-template.yaml` to `config.yaml`
+3. Update `config.yaml` to fit your needs
+4. Open terminal / cmd in the directory of the jar and the config file 
+5. Execute following commands:
+   1. (Optional) `java -jar mkvaudiosubtitleschanger.jar -l [path to mkv or dir with mkv] --safe-mode`
+   2. To permanently apply changes: `java -jar mkvaudiosubtitleschanger.jar -l [path to mkv or dir with mkv]`
 
-`java -jar mkvaudiosubtitleschanger.jar -l [path to mkv or dir with mkv]`
+### Configuration
 
-### Additional arameters
-These properties overwrite already existing values in the config file.
-```properties
- -c,--config                      path to config
- -e,--exclude-directories <arg>   Directories to exclude
- -h,--help                        "for help this is" - Yoda
- -i,--include-pattern <arg>       Include files matching pattern
- -k,--forcedKeywords <arg>        Additional keywords to identify forced tracks"
- -l,--library <arg>               path to library
- -s,--safe-mode                   Test run (no files will be changes)
- -t,--threads <arg>               thread count
-```
-
-### config.yml example
-Config file needs to be placed in the same directory as the jar or path to config has to be passed via command line 
+Config file needs to be placed in the same directory as the jar or path to config has to be passed via command line
 argument.
 
+The list of language configurations can be expanded. Use `OFF` if you want to turn of the audio or subtitle lane. 
+Players probably will display forced subtitles nonetheless.
 ```yaml
-mkvtoolnixPath: C:\Program Files\MKVToolNix
-# Recommendations for data stored on HDDs, increase when using SSDs
-threads: 2
-#forcedKeywords: ["forced", "signs"]
 config:
   1:
     audio: ger
@@ -50,3 +41,19 @@ config:
     subtitle: ger
 ```
 Subtitle lanes recognized as forced will be set as one. Already existing ones will not be overwritten or changed.
+
+
+### Additional arameters
+These properties overwrite already existing values in the config file.
+```properties
+ -c,--config <arg>                Path to config file
+ -e,--exclude-directories <arg>   Directories to be excluded, combines with config file
+ -h,--help                        "for help this is" - Yoda
+ -i,--include-pattern <arg>       Include files matching pattern
+ -k,--forcedKeywords <arg>        Additional keywords to identify forced tracks, combines with config file
+ -l,--library <arg>               Path to library
+ -m,--mkvtoolnix <arg>            Path to mkv tool nix installation
+ -s,--safe-mode                   Test run (no files will be changes)
+ -t,--threads <arg>               thread count (default: 2)
+ -v,--version                     Display version
+```