Merge branch 'release/0.2.4'

Author: JavonDavis

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parallel_appium (0.2.2)
+    parallel_appium (0.2.3)
 
 GEM
   remote: https://rubygems.org/

README.md

@@ -1,18 +1,29 @@
 # parallel_appium
 
-Single and Distributed Parallel mobile testing in Appium and RSpec fro Android and iOS
+Single/Distributed Parallel Cross-Platform mobile testing in Appium and RSpec for Android and iOS.
 
-## Quick check
+This project acts as a wrapper around a number of the configurations that have to be in place for 
+running appium tests with RSpec. 
 
-If you'd like to check if you're good to go for this project simply execute
+The Gem:
 
-```rake parallel_appium:validate_android``` for Android
+* Handles single platform testing 
+* Does cross-platform testing in Parallel
+* Distributes tests across multiple simulator instances for a platform
 
-```rake parallel_appium:validate_ios``` for iOS
+Using the gem will speed up the time your entire test suite takes to execute and reducing your 
+project size by packaging a lot of code that is not context-specific. 
 
+This project depends on [Appium](http://appium.io/), please ensure you've installed and configured Appium
+correctly before trying to work with this gem. [Appium Doctor](https://github.com/appium/appium-doctor) is a good way to
+ensure you're good to go here
 
-The messages will indicate if there's any component necessary for the platform that's still not set up as yet.
+## Sample Project
+
+To better demonstrate how to use the gem, a project automating Wordpress's mobile apps
+is presented [here](https://github.com/JavonDavis/Wordpress-Open-Source-Automation-Ruby).
 
+This project shows hands on how to integrate the gem and what it can do.
 
 ## Installation
 
@@ -29,10 +40,51 @@ And then execute:
 Or install it yourself as:
 
     $ gem install parallel_appium
+    
+## Getting setup
+
+## Android
+
+The gem uses the emulator command line tool that comes with your Android installation to manage a number of things. This
+however requires a bit of configuration to work properly as by default it's not added to the system path and it's usually
+not pointing to the correct one. Adding something like this(**in the specified order**) in your bash_profile will resolve
+this 
+
+```
+export ANDROID_HOME=/<path>/to/Android/sdk
+export ANDROID_AVD_HOME=~/.android/avd
+export PATH=$ANDROID_HOME/platform-tools:$PATH
+export PATH=$ANDROID_HOME/tools:$PATH
+export PATH=$ANDROID_HOME/tools/bin:$PATH
+export PATH=$ANDROID_HOME/emulator:$PATH
+```
+
+## iOS
+
+The main requirement here is to be running on a MAC machine, otherwise, there's nothing extra to do here
+all the requirements for Appium and iOS hold true. 
 
-## Getting started and ssage
+### Additional check
 
-To get started with this gem there's 3 lines of code you'll need to know to include within your project.
+I also recommend an additional check to see if you're good to go for this project, simply execute
+
+```bundle install --path vendor```
+
+and then 
+
+```bundle exec rake parallel_appium:validate_android``` for Android
+
+or
+
+```bundle exec rake parallel_appium:validate_ios``` for iOS
+
+
+The messages will indicate if there's any component necessary for the platform that's still not set up as yet.
+
+
+## Usage
+
+To get started with this gem in a project there's 3 lines of code you'll need to know to include within your project.
 These lines handle the following.
 
 ### Starting the servers
@@ -74,6 +126,47 @@ and the library will set this up as needed,
 This is all you need to get started with this library. There's a number of environment variables set by the library
 for the purpose of writing easier cross platform tests. These are described in more detail below.
 
+
+--------
+
+Next you'll need to ensure the project the respective appium text files for the platform, 
+the gem will be looking for these files in the Project root. This file is used to load the capabilities of the driver
+at launch.
+
+Here's examples of what both could look like 
+
+### appium-ios.txt
+
+```
+[caps]
+platformName = "ios"
+deviceName = "iPhone Simulator"
+platformVersion = "11.4"
+app = "./apps/WordPress.app.zip"
+automationName = "XCUITest"
+bundleId = "org.wordpress"
+
+[appium_lib]
+wait = 2
+```
+
+### appium-android.txt
+
+```
+[caps]
+platformName = "android"
+deviceName = "Android Emulator"
+platformVersion = "8.1.0"
+app = "./apps/WordPress.apk"
+appActivity = "org.wordpress.android.ui.WPLaunchActivity"
+appPackage = "org.wordpress.android"
+
+[appium_lib]
+wait = 2
+```
+
+The vales are expected to change to tailor to the host machine.
+
 ### Environment variables
 
 

lib/parallel_appium/version.rb

@@ -1,3 +1,3 @@
 module ParallelAppium
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.2.4'.freeze
 end

parallel_appium.gemspec

@@ -3,11 +3,11 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'parallel_appium/version'
 
-summary = 'Start multi-threaded appium servers'
+summary = 'Multi-threaded mobile testing with Appium, Selenium and Rspec'
 description = 'Through the creation of multiple environments
  this library allows for the distribution of multiple tests across 1 or more
 devices or simulators. The library uses Selenium Grid and Appium to launch a
-specified number of web driver and appium instances to spread the test load
+specified number of web driver and appium instances to distribute the RSpec test load
 across available devices'
 
 Gem::Specification.new do |spec|