Merge pull request #15 from swaraliRaut/master

updating code samples

Author: agundawar

README.md

@@ -4,5 +4,53 @@ cucumber-ruby-app-browserstack
 
 Code samples to get started with Appium tests for your Native App using the Cucumber framework.
 
-## Resources
-* [Get Started guide](https://www.browserstack.com/app-automate/appium-cucumber)
+## Setup
+### Requirements
+
+1. Ruby: If you don't have Ruby installed, follow the instructions given [here](https://www.ruby-lang.org/en/documentation/installation/)
+2. Bundler : If you dont have Bundler installed, follow the instructions given [here](https://bundler.io/)
+
+### Install the dependencies
+
+To install the dependencies for Android tests, run :
+```sh
+cd android/examples
+bundle install
+```
+
+Or,
+
+To install the dependencies for iOS tests, run :
+
+```sh
+cd ios/examples
+bundle install
+```
+
+## Getting Started
+
+Getting Started with Appium tests in Cucumber Ruby on BrowserStack couldn't be easier!
+
+### **Run first test :**
+
+- Switch to `run_first_test` directory under [Android examples](android/examples) or [iOS examples](ios/examples)
+- Follow the steps outlined in the documentation - [Get Started with your first test on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/ruby/cucumber)
+
+### **Speed up test execution with parallel testing :**
+
+- Switch to `run_parallel_test` directory under [Android examples](android/examples/) or [iOS examples](ios/examples/)
+- Follow the steps outlined in the documentation - [Get Started with parallel testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/ruby/cucumber/local-testing)
+
+### **Use Local testing for apps that access resources hosted in development or testing environments :**
+
+- Switch to `run_local_test` directory under [Android examples](android/examples/) or [iOS examples](ios/examples/)
+- Follow the steps outlined in the documentation - [Get Started with Local testing on App Automate](https://www.browserstack.com/docs/app-automate/appium/getting-started/ruby/cucumber/local-testing)
+
+## Getting Help
+
+If you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help).  
+
+Note: For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)
+
+## Addtional Resources
+* [Cucumber](https://cucumber.io/)

android/Gemfile.lock

@@ -0,0 +1,125 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appium_lib (10.6.0)
+      appium_lib_core (~> 3.3)
+      nokogiri (~> 1.8, >= 1.8.1)
+      tomlrb (~> 1.1)
+    appium_lib_core (3.11.0)
+      faye-websocket (~> 0.11.0)
+      selenium-webdriver (~> 3.14, >= 3.14.1)
+    browserstack-local (1.3.0)
+    builder (3.2.4)
+    childprocess (3.0.0)
+    chunky_png (1.3.12)
+    concurrent-ruby (1.1.7)
+    cucumber (5.1.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-create-meta (~> 2.0, >= 2.0.1)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-html-formatter (~> 9.0, >= 9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-wire (~> 4.0, >= 4.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-core (8.0.1)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (2.0.1)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.3.0)
+    cucumber-gherkin (15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-html-formatter (9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-messages (13.0.1)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (4.0.1)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    diff-lcs (1.4.4)
+    eventmachine (1.2.7)
+    faye-websocket (0.11.0)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    ffi (1.13.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    middleware (0.1.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    multi_test (0.1.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parallel_tests (3.2.0)
+      parallel
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubyzip (2.3.0)
+    selenium-cucumber (3.1.5)
+      appium_lib (>= 8.0.2)
+      chunky_png (>= 1.3.5)
+      cucumber (>= 2.3.0)
+      rspec (>= 3.4.0)
+      selenium-webdriver (>= 2.53.0)
+    selenium-webdriver (3.142.7)
+      childprocess (>= 0.5, < 4.0)
+      rubyzip (>= 1.2.2)
+    sys-uname (1.2.1)
+      ffi (>= 1.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tomlrb (1.3.0)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appium_lib
+  browserstack-local
+  cucumber
+  parallel_tests
+  rake
+  rspec
+  selenium-cucumber
+  selenium-webdriver
+
+BUNDLED WITH
+   1.17.3