[maven-verifier] 01/01: [MSHARED-1128] Update documentation with new execute method

[sj...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sjaranowski pushed a commit to branch MSHARED-1128-doc
in repository https://gitbox.apache.org/repos/asf/maven-verifier.git

commit 0f68bbabb525683d2b494920cfdb336c40d0ebe3
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Tue Sep 20 18:54:37 2022 +0200

    [MSHARED-1128] Update documentation with new execute method
---
 src/site/markdown/getting-started.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/site/markdown/getting-started.md b/src/site/markdown/getting-started.md
index 7e77135..ca538d7 100644
--- a/src/site/markdown/getting-started.md
+++ b/src/site/markdown/getting-started.md
@@ -129,17 +129,24 @@ For the Context Class Loader case this would mean the following dependencies are
 
 ## Run
 
-Calling `executeGoals` runs Maven with the given goals or phases and optionally some additional environment variables. It throws a `VerificationException` in case the execution is not successful (e.g. binary not found or exit code > 0). It is either using a forked JVM or is executed in the same JVM depending on the configuration.
+Calling `execute` runs Maven with the given Verifier configuration like, cli arguments, environment variables. 
+We must provide at lease one cli argument for executing.
+
+It throws a `VerificationException` in case the execution is not successful (e.g. binary not found or exit code > 0). 
+It is either using a forked JVM or is executed in the same JVM depending on the configuration.
 
 ```
-verifier.executeGoals( "package" );
+verifier.addCliArgument( "package" )
+verifier.execute();
 ```
 
 ## Verify
 
-After executing the Maven goals there are several methods starting with prefix `verify` which allow you to check for the build result, check the log for certain contents and the existence of generated artifacts.
+After executing the Maven process there are several methods starting with prefix `verify` 
+which allow you to check for the build result, check the log for certain contents and the existence of generated artifacts.
 
-The main method `verify(boolean)` takes into consideration a file named `expected-results.txt` being located in the base directory. Each line consists of a file path (optionally prefixed by `!`) and it is automatically verified that the file exists or is missing (in case the path starts with `!`).
+The main method `verify(boolean)` takes into consideration a file named `expected-results.txt` being located in the tested project base directory. 
+Each line consists of a file path (optionally prefixed by `!`) and it is automatically verified that the file exists or is missing (in case the path starts with `!`).
 
 ```
 verifier.verify( true ); // if true, throws an exception in case of errors in the build log