Adding README for initiating

Author: yazidisme

README.md

@@ -1 +1,55 @@
-# selenium-cucumber-framework
+# Selenium Cucumber Framework
+
+---
+
+## Project Purpose
+This project aims to give an inspiring or sample of automation test framework that uses Selenium and Cucumber with Java as the programming language.
+
+You can see pieces of framework components that build on every git branch.
+For example, you want to see how `Hooks` is implemented in the framework.
+Just select the `Hooks` branch then you will see the magic.
+
+![select branch](https://github.com/yazidisme/image-attachment/blob/master/seleniumcucumberframework1.png)
+
+If you want to go back to the current branch, you can select `main` as the default branch.
+
+---
+
+## Tools and Libraries
+This project using 2 main tools, Selenium and Cucumber.
+On the other hand, I using some of the tools that support this great framework.
+The complete list of tools, you can see in the `pom.xml` file.
+
+## Requirements
+* Java Development Kit
+* Maven
+* WebDriver, (anything or my recommendation using ChromeDriver)
+
+## Running Tests
+* Clone the repository from your fork to this directory
+* Open the project using any Java IDE
+* Run the tests with the script below
+```shell
+$ mvn clean install
+```
+* If you want to run the specific test, use the cucumber tags like this
+```shell
+$ mvn clean install -Dcucumber.filter.tags="@REPLACE_WITH_ANY_TAGS_THAT_YOU_WANT"
+```
+
+## Test Results
+* Test report automatically generated on `target` folder after finished the test execution
+* Open overview-features.html file on your browser from target/cucumber-reports/advanced-reports/cucumber-html-reports folder
+* You can also share your Cucumber Report with another person at https://reports.cucumber.io, just go to `cucumber.properties` file in `src/test/resources` folder then change the value to be `true`
+```properties
+cucumber.publish.enabled=true
+```
+* For more information about reports cucumber you can go to https://reports.cucumber.io/docs/cucumber-jvm
+
+---
+
+### References
+* https://cucumber.io/docs/installation/java/
+* https://www.selenium.dev/documentation/en/
+* https://www.toolsqa.com/cucumber-automation-framework/
+* https://www.w3schools.com/java/