Update the README.md file (#67)

Fixes #40

Signed-off-by: Zbynek Cervinka <[email protected]>

Author: zcervink

README.md

@@ -1,9 +1,43 @@
-# intellij-common-ui-test-library
+Welcome to the IntelliJ IDEA UI test library project! Here you'll find several pieces of information and advices on how to setup, use and contribute to this library.
 
-### Add this library to an existing IntelliJ Plugin project
+## Purpose of this project
+This project allows you to create automated UI tests for your IntelliJ IDEA plugin project. Using this library you are able to access UI elements such as buttons, inputs, tree elements etc. and perform actions with them. Navigating through wizards, clicking on buttons or editing file content of newly created project could be automated using this library.
 
-1) Extend the build.gradle file of the IntelliJ Plugin repo
+## Any Suggestions or Questions?
+Please submit an [issue](https://github.com/redhat-developer/intellij-common-ui-test-library/issues) to this project.
 
+## Contributing
+Feel free to contribute to this project! See the [contribution guide](https://github.com/redhat-developer/intellij-common-ui-test-library/blob/main/CONTRIBUTING.md) for more details.
+
+## Quick setup
+The setup of this library is easy - just extend the **build.gradle** file as described in the following steps and you are ready to write your first UI test.
+
+### STEP #1: Adding repositories
+You need to add the following nexus and JetBrains repositories:
+```
+repositories {
+    maven {
+        url 'https://repository.jboss.org/nexus/content/repositories/snapshots'
+    }
+    maven {
+        url 'https://repository.jboss.org/nexus/content/groups/public'
+    }
+    maven {
+        url 'https://packages.jetbrains.team/maven/p/ij/intellij-dependencies'
+    }
+}
+```
+
+### STEP #2: Adding dependencies
+Add the following dependency:
+```
+dependencies {
+    compile 'com.redhat.devtools.intellij:intellij-common-ui-test-library:0.0.3'
+}
+```
+
+### STEP #3: Adding source sets
+The following source set is needed to define where in your project will be your UI tests and resources located. The following example displays the 'src/it/java' location for java code of UI tests and the 'src/it/resources' location for resources:
 ```
 sourceSets {
     integrationTest {
@@ -13,7 +47,10 @@ sourceSets {
         runtimeClasspath += output + compileClasspath
     }
 }
+```
 
+### STEP #4: Adding tasks
+```
 task integrationTest(type: Test) {
     useJUnitPlatform()
     description = 'Runs the integration tests.'
@@ -24,32 +61,51 @@ task integrationTest(type: Test) {
     mustRunAfter test
 }
 
-dependencies {
-    compile 'com.redhat.devtools.intellij:intellij-common-ui-test-library:0.0.3-SNAPSHOT'
-}
-
 runIdeForUiTests {
     systemProperty "robot-server.port", System.getProperty("robot-server.port")
 }
-
-repositories {
-    maven {
-        url 'https://packages.jetbrains.team/maven/p/ij/intellij-dependencies'
-    }
-}
 ```
 
-2) Run and close the IntelliJ Idea before and after all the UI tests
+## Start and quit IntelliJ IDEA
+Use the following code to start IntelliJ before running the first UI test. The runIde() method not only starts the IDE for UI tests, it also returns reference to the Remote-Robot instance which will be useful later to access UI elements such as buttons, inputs etc.
 ```
 private static RemoteRobot robot;
 
 @BeforeAll
 public static void runIdeForUiTests() {
-    robot = UITestRunner.runIde("IC-2020.3", 8580);
+    robot = UITestRunner.runIde(UITestRunner.IdeaVersion.V_2020_3, 8580);
 }
+```
 
+After executing all the UI tests close the IDE by running the following command:
+```
 @AfterAll
 public static void closeIde() {
     UITestRunner.closeIde();
 }
 ```
+
+## What next? Implement your first UI test!
+After you manage to setup this library to your project and successfully start and quit IntelliJ IDEA, there is no more setup needed. Just start writing your UI tests! Here are some examples that will help you get started:
+
+### Create your first fixture
+Create an instance of a FlatWelcomeFrame class which allows you to access the 'Welcome to IntelliJ IDEA' dialog's UI.
+```
+FlatWelcomeFrame flatWelcomeFrame = remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10));
+```
+
+### Use the fixture to access UI
+After you have the object, it can be used to access the UI - here is an example of clicking on the 'New Project' button:
+```
+flatWelcomeFrame.createNewProject();
+```
+
+### Use utilities
+This library provides several static utility methods for common actions. Here is an example of one useful transformation method:
+```
+String contentListStr = TextUtils.listOfRemoteTextToString(contentList);
+```
+
+### Use any tool provided by Remote-Robot framework
+Besides the fixtures and utilities provided by this library you can use any tool from the [Remote-Robot](https://github.com/JetBrains/intellij-ui-test-robot) framework itself. 
+