Update markdown documents

Author: KMariusz

CONTRIBUTING.md

@@ -1,14 +1,9 @@
 # Pull request general verifications
 
-## Jenkins job link
-
-Example Jenkins job link   http://10.40.232.131:8081/job/Training/job/selenium_workshop/197/allure/
-
 ## Branch naming convention
 
 Example:  *feature/LUSTEF-Zad12*
 
-
 # Every file
 
 ## Remove commented out lines of code and empty lines
@@ -17,7 +12,7 @@ Remove ```// Commented lines``` and empty lines
 
 ## Enable file formatting 
 
-By default file formatting should be already uploaded to Eclipse.
+By default, file formatting should be already uploaded to Eclipse.
 
 * Eclipse -> Preferences -> Java -> Code Style -> Formatter -> Import [eclipse_format_code_standards.xml](https://bitbucket.org/capntc/selenium_workshop/src/cc4f1840dd7b2831907526c47bdf247ab74903a2/README/eclipse_format_code_standards.xml?at=develop)
 
@@ -130,8 +125,4 @@ Type of variable: *private static final*
 
 Naming: selector[ElementName]
 
-`private static final By selectorResultBanner = By.cssSelector("#hdtb-msb-vis");`
-
-
-
-
+`private static final By selectorResultBanner = By.cssSelector("#hdtb-msb-vis");`

README.md

@@ -1,20 +1,47 @@
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdevonfw%2Fdevonfw-testing.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdevonfw%2Fdevonfw-testing?ref=badge_shield)
 
-# Install #
+![MrChecker.png](resources%2Fimg%2FMrChecker.png)
 
-1. Download package [TestEnvironment](https://github.com/devonfw/devonfw-testing/releases/download/2.6.0/MrChecker_Test_Framework.7z)
-2. To folder **C:\\** unzip with [7z](http://www.7-zip.org/download.html)
-3. In unzipped folder run  _C:\MrChecker_Test_Framework\start-eclipse.bat_
+Java E2E Testing Framework accelerating tests creation and reducing maintenance costs
 
-Full information about install you could find here [GitHub Wiki](https://github.com/devonfw/devonfw-testing/wiki/How-to-install)
+# Modules #
 
+Our testing framework consists of multiple modules you can use depending on your needs. 
+* Core (base functionality and dependency for all other modules)
+* Selenium
+* Playwright
+* Web API (with RestAssured)
+* CLI
+* Database
+* Mobile (with Appium)
 
-# Run test case #
 
-*Junit - classic*
-> mvn clean test-compile test site -Dtest=RegisterOKTest
+![Modules.PNG](resources%2Fimg%2FModules.PNG)
 
+# Maven dependency #
 
+Each of module can be used as a Maven dependency. \
+You can check list of all related Maven artifacts here:
+https://mvnrepository.com/artifact/com.capgemini.mrchecker
+
+As an example if you want to use Selenium module in your project you must add it as a dependency to your pom.xml file:
+
+> <!-- https://mvnrepository.com/artifact/com.capgemini.mrchecker/mrchecker-selenium-module --> \
+ <dependency> \
+    <groupId>com.capgemini.mrchecker</groupId> \
+    <artifactId>mrchecker-selenium-module</artifactId> \
+    <version>*VERSION</version> \
+ </dependency>
+
+* VERSION can be found on [releases page](https://github.com/devonfw-forge/mrchecker-source/releases)
+
+# Releases #
+
+Visit [releases page](https://github.com/devonfw-forge/mrchecker-source/releases) to check newest version and related changes.
+
+# Examples #
+
+Visit [examples](https://github.com/devonfw/mrchecker) for some use cases you can use to start your own project
 
 ## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdevonfw%2Fdevonfw-testing.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdevonfw%2Fdevonfw-testing?ref=badge_large)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdevonfw%2Fdevonfw-testing.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdevonfw%2Fdevonfw-testing?ref=badge_large)