update documentation

Author: AnakinRaW

README.md

@@ -1,5 +1,4 @@
 # ModVerify: A Mod Verification Tool
-
 ModVerify is a command-line tool designed to analyze 
 mods for the game Star Wars: Empire at War and its expansion Forces of Corruption 
 for common errors in XML and other game files.
@@ -8,6 +7,7 @@ for common errors in XML and other game files.
 
 - [Installation](#installation)
 - [Usage](#usage)
+- [Getting Updates](#getting-updates)
 - [Options](#options)
 - [Available Checks](#available-checks)
 - [Creating a new Baseline](#creating-a-new-baseline)
@@ -18,51 +18,73 @@ for common errors in XML and other game files.
 
 Download the latest release from the [releases page](https://github.com/AlamoEngine-Tools/ModVerify/releases). There are two versions of the application available. 
 
-1. `ModVerify.exe` is the default version. Use this if you simply want to verify your mods. This version only works on Windows.
-2. `ModVerify-NetX.zip` is the cross-platform app. It works on Windows and Linux and is most likely the version you want to use to include it in some CI/CD scenarios.
+1. `ModVerify.exe` (**recommended**): Use this if you simply want to verify your mods. This version only works on Windows.
+2. `ModVerify-NetX.zip`: Cross-platform app. It works on Windows and Linux and is most likely the version you want to use to include it in some CI/CD scenarios.
 
 You can place the files anywhere on your system, eg. your Desktop. There is no need to place it inside a mod's directory. 
 
-***Note**: Both versions have the exact same feature set. They just target a different .NET runtime. Linux and CI/CD support is not fully tested yet. Current priority is on the Windows-only version.*
+***Note**: Only the Windows version supports automatic updates. 
+Except for that both versions have the exact same feature set. 
+They just target a different .NET runtime. Linux and CI/CD support is not fully tested yet. 
+Current priority is on the Windows-only version.*
 
 ---
 
 ## Usage
 
 Simply run the executable file `ModVerify.exe`. 
 
-When given no specific argument through the command line, ModVerify will ask you which game or mod you want to verify. When ModVerify is done analyzing, it will write the verification results into new files next to the executable. 
+When given no specific argument through the command line, ModVerify will ask you which game or mod you want to verify. 
+When ModVerify is done analyzing, it will write the verification results into a folder `ModVerifyResults` next to the executable. 
+
+![ModVerify Image](./docs/ModVerify.png "ModVerify")
 
 A `.JSON` file contains all identified issues. The additional `.txt` files contain the same errors but are grouped by the verifier that reported the issue. 
-The text files may be easier to read, while the JSON file is more useful for 3rd party tool processing.   
+The text files may be easier to read, while the JSON file is more useful for 3rd party tool processing.  
 
-## Options
+*Vanilla Empire at War is currently not supported.*
+
+---
 
-You can also run the tool with command line arguments to adjust the tool to your needs. 
+## Getting Updates
 
-To see all available options, especially if you have custom folder setups, open the command line and type:
+ModVerify automatically check for updates. 
+
+*The following applies to the Windows (.NET Framework) version only*
+
+When executed with no arguments the application automatically checks for an available update and will ask you whether you want to update now.
+Otherwise, the app only informs you whether an update is available.
+
+You can use the dedicated `updateApplication` option to trigger an update.
 
 ```bash
-ModVerify.exe --help
+.\ModVerify.exe updateApplication
 ```
 
-Here is a list of the most relevant options: 
+***Note:***
+You may be required to put ModVerify on your AntiVirus whitelist.
+
+---
+
+## Options
 
-### `--path`
-Specifies a path that shall be analyzed. **There will be no user input required when using this option**
+You can also run the tool with command line arguments to specify custom behavior. 
 
-### `--output`
-Specified the output path where analysis result shall be written to.
+To see all available options, especially if you have custom folder setups, open the command line and type:
 
-### `--baseline`
-Specifies a baseline file that shall be used to filter out known errors. You can download the [FoC baseline](focBaseline.json) which includes all errors produced by the vanilla game.
+```bash
+.\ModVerify.exe --help
+```
 
+In general ModVerify has two operation mods. 
+1. `verify` Verifying a game or mod 
+2. `createBaseline` Creating a baseline for a game or mod, that can be used for further verifications in order to verify you did not add more errors to your mods.
 
 ### Example
 This is an example run configuration that analyzes a specific mod, uses a the FoC basline and writes the output into a dedicated directory: 
 
 ```bash
-ModVerify.exe --path "C:\My Games\FoC\Mods\MyMod" --output "C:\My Games\FoC\Mods\MyMod\verifyResults" --baseline focBaseline.json
+.\ModVerify.exe verify --path "C:\My Games\FoC\Mods\MyMod" --outDir "C:\My Games\FoC\Mods\MyMod\verifyResults" --baseline ./focBaseline.json
 ```
 
 ---
@@ -80,12 +102,12 @@ The following verifiers are currently implemented:
 - Checks the referenced textures exist
 
 ### GameObjects
-- Checks the referenced models for validity (textures, particles and shaders)
+- Checks the referenced models for validity (ALO file, textures, particles and shaders)
 - Duplicates
 
 ### Engine
 - Performs assertion checks the Debug builds of the game are also doing (not complete)
-- Sports XML errors and unexpected values
+- XML errors and unexpected values
 
 ---
 
@@ -95,5 +117,5 @@ If you want to create your own baseline use the `createBaseline` option.
 
 ### Example
 ```bash
-ModVerify.exe createBaseline -o myBaseline.json --path "C:\My Games\FoC\Mods\MyMod"
+ModVerify.exe createBaseline --outFile myBaseline.json --path "C:\My Games\FoC\Mods\MyMod"
 ```