readme.md in appium_lib-0.3.2 vs readme.md in appium_lib-0.3.3
- old
+ new
@@ -27,18 +27,45 @@
#### Simple Usage
```ruby
require 'appium_lib'
-# Start a driver based on APP_PATH
-Appium::Driver.new.start_driver
+# Start an iOS driver based on APP_PATH
+app = { 'APP_PATH' => '/path/to/MyiOS.app' }
+Appium::Driver.new(app).start_driver
# Start an Android driver
# must quit old driver before starting a new one
driver_quit
-apk = { 'APP_PATH' => ENV['APP_APK'] }
+apk = { 'APP_PATH' => '/path/to/the.apk',
+ 'APP_PACKAGE' => 'com.example.pkg',
+ 'APP_ACTIVITY' => 'act.Start',
+ 'APP_WAIT_ACTIVITY' => 'act.Splash' }
Appium::Driver.new(apk).start_driver
```
+
+#### iOS env vars
+
+- `APP_PATH` Path to the .app folder
+
+#### Android env vars
+
+- `APP_PATH` Path to the apk
+- `APP_PACKAGE` The APK's package
+- `APP_ACTIVITY` Activity to start
+- `APP_WAIT_ACTIVITY` Optional. Activity to wait for.
+
+#### Sauce Labs env vars
+
+- `APP_NAME` Name of the test run
+- `SAUCE_USERNAME` Sauce username
+- `SAUCE_ACCESS_KEY` Sauce API key
+
+#### Troubleshooting
+
+1. Does `adb kill-server; adb devices` list an active Android device?
+2. Have you defined the proper env vars? `APP_PATH, APP_PACKAGE, APP_ACTIVITY, APP_WAIT_ACTIVITY`
+3. Are you running appium from source? `node server.js -V --fast-reset`
#### Documentation
See [docs.md](https://github.com/appium/ruby_lib/blob/master/docs.md)