Merge pull request #14 from testdevlab/update_readme

Update README.md to include warning to install Python certificates

Author: alvarolaserna

README.md

@@ -1,27 +1,63 @@
 # Py-TestUI Framework
 
-## Appium
+# Installation
 
-The folder testui contains the logic for Appium Driver and actions. Then you can start a session by using:
+Py-TestUI can be installed via `pip`
 
-<pre>
-    driver: TestUIDriver = NewDriver()\
-        .set_app_path("app.apk")\
-        .set_app_package_activity("com.package.package", "com.activity.Activity")\
-        .set_logger("pytest").set_appium_driver()
-</pre>
+```bash
+pip3 install git+https://github.com/testdevlab/Py-TestUI@v1.0.6
+```
+
+Or if you prefer `requirements.txt`, you can add the following dependecy
+
+```
+git+https://github.com/testdevlab/Py-TestUI@v1.0.6
+```
+
+# Appium driver
 
-By default it takes the first connected device to your machine, but you can specify device by calling `.set_udid("udid")`
-before the `set_appium_driver()` call
+You can create `TestUIDriver` for Appium automation like so:
+
+```py
+driver: TestUIDriver = (
+    NewDriver()
+    .set_app_path("app.apk")
+    .set_app_package_activity("com.package.package", "com.activity.Activity")
+    .set_logger("pytest")
+    .set_appium_driver()
+)
+```
 
-## Selenium Desktop
+By default it takes the first connected device to your machine, but you can specify device by calling `.set_udid("udid")` before the `.set_appium_driver()` call.
 
-In mac start by `brew install chromedriver`
+# Selenium Desktop driver
 
-<pre>
-    driver: TestUIDriver = NewDriver() \
-            .set_logger("pytest").set_soft_assert(True).set_selenium_driver()
-</pre>
+Py-TestUI supports the following browser drivers:
+
+- Google Chrome (`'chrome'`)
+- Mozzila Firefox (`'firefox'`)
+- Safari (`'safari'`)
+- Microsoft Edge (`'edge'`)
+- Microsoft Internet Explorer (`'ie'`)
+- Opera (`'opera'`)
+- PhantomJS(`'pantomjs'`)
+
+> All these drivers must be installed and added to you `$PATH` variable
+
+> Mozzila Firefox is downloaded automatically and added to `$PATH` but
+> double-check that you have installed
+> [Python certificates if you are using macOS](https://stackoverflow.com/a/53310545/13179904)
+
+You can create `TestUIDriver` for Selenium Desktop automation like so
+
+```python
+driver: TestUIDriver = (
+    NewDriver()
+    .set_logger("pytest")
+    .set_soft_assert(True)
+    .set_selenium_driver()
+)
+```
 
 # Configuration
 
@@ -45,9 +81,10 @@ driver: TestUIDriver = (
     .set_selenium_driver()
 )
 ```
+
 ## Configuration via `driver.configuration`
 
-Another possible way to change default global parameters is to use 
+Another possible way to change default global parameters is to use
 `configuration` attribute located under `driver: TestUIDriver` object. These
 parameters can be changed like this at any point of the execution:
 
@@ -83,7 +120,7 @@ The automation infrastructure implements the Page Object Model (POM) pattern. Th
             .
 ```
 
-The test case scripts are in a different class. The scripts import the respective screen package along with additional packages such as PyTest. Each class has any amount of tests. All test methods start with the word “test_” such as:
+The test case scripts are in a different class. The scripts import the respective screen package along with additional packages such as PyTest. Each class has any amount of tests. All test methods start with the word “test\_” such as:
 
 ```py
     def test_add_existing_contact(self, appium_driver):

testui/support/testui_driver.py

@@ -168,8 +168,8 @@ def save_screenshot(self, image_name=""):
         root_dir = config.screenshot_path
         if not config.screenshot_path:
             root_dir = path.dirname(path.dirname(path.dirname(path.abspath(__file__))))
+            root_dir = path.join(root_dir, "report_screenshots")
 
-        root_dir = path.join(root_dir, "report_screenshots")
         Path(root_dir).mkdir(parents=True, exist_ok=True)
 
         current_time = datetime.now().strftime("%Y-%m-%d%H%M%S")