Update README.md

README.md

@@ -1,59 +1,49 @@
-### Table of content
- - Introduction
- - Requirements
- - Running
- - Configuration
- - Additional parameters
- 
-### Introduction
+## Introduction
 
-This program helps to change audio and subtitle lines of mkv files.
+This program helps to change audio and subtitle tracks of mkv files without rewriting the file. Only track properties will be updated.
 
-### Requirements
+## Requirements
 
  - Java 11 or higher
  - mkvtoolnix installation
  
-### Running
+## Execution
+**Minimal usage:**
+`java -jar mkvaudiosubtitlechanger.jar --library "X:/Files" --attribute-config eng:ger eng:OFF`
 
-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]`
+**Safe usage (best for testing before applying to whole library):**
+`java -jar mkvaudiosubtitlechanger.jar --library "X:/Files" --attribute-config eng:ger eng:OFF --safe-mode`
 
-### Configuration
+Attribute-config must be entered in pairs: `audio:subtitle`; Example: `jpn:eng`. More about this topic
+[here](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/Attribute-Config).
 
-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
-config:
-  1:
-    audio: ger
-    subtitle: OFF
-  2:
-    audio: eng
-    subtitle: ger
+## Available parameters
+```shell
+   -l,--library <arg>                Path to library
+   -a,--attribute-config <arg>       Attribute config to decide which tracks to choose when
+   -p,--config-path <arg>            Path to config file
+   -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)
+   -i,--include-pattern <arg>        Include files matching pattern (default: ".*")
+   -e,--exclude-directories <arg>    Directories to be excluded, combines with config file
+   -fk,--forced-keywords <arg>       Additional keywords to identify forced tracks
+   -ck,--commentary-keywords <arg>   Additional keywords to identify commentary tracks
+   -v,--version                      Display version
+   -h,--help                         "For help this is" - Yoda
 ```
-Subtitle lanes recognized as forced will be set as one. Already existing ones will not be overwritten or changed.
 
+All parameters can also be defined in a config file. 
+Please read [this wiki page](https://github.com/RatzzFatzz/MKVAudioSubtitleChanger/wiki/How-to-config-file)  for more information.
 
-### 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
-```
+## Build requirements
+- JDK 11 or higher
+- Maven 3
+- Git
+
+## Build from source
+```shell
+git clone https://github.com/RatzzFatzz/MKVAudioSubtitleChanger.git
+cd MKVAudioSubtitleChanger
+mvn package
+```