diff --git a/README.md b/README.md index 6bafcd7..2eb6060 100755 --- a/README.md +++ b/README.md @@ -1,38 +1,16 @@ -# testng-browserstack +# Cucumber-browserstack -[TestNG](http://testng.org) Integration with BrowserStack. - -Master branch contains **Selenium 3** samples, for **Selenium 4 - W3C protocol** please checkout [selenium-4](https://github.com/browserstack/testng-browserstack/tree/selenium-4) branch +Documentation for running [Cucumber](https://cucumber.io/) Integration with BrowserStack. ![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780) -## Setup - -* Clone the repo -* Install dependencies `mvn compile` -* Update `*.conf.json` files inside the `src/test/resources/conf` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings) - -## Running your tests - -- To run a single test, run `mvn test -P single` -- To run local tests, run `mvn test -P local` -- To run parallel tests, run `mvn test -P parallel` -- To run the test suite, run `mvn test -P suite` - - Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github) +## Getting Started +`Note: Refer our sample repo on Github: `[cucumber-browserstack](http://www.google.com) -## Notes -* You can view your test results on the [BrowserStack Automate dashboard](https://www.browserstack.com/automate) -* To test on a different set of browsers, check out our [platform configurator](https://www.browserstack.com/automate/java#setting-os-and-browser) -* You can export the environment variables for the Username and Access Key of your BrowserStack account +BrowserStack supports Selenium automated tests using Cucumber, and running your tests on our cloud setup is simple and straightforward. Get started with a sample test, which opens Google's homepage, searches for ‘BrowserStack’, and asserts for the title of the search results page. For the code to run successfully on your machine, please ensure that the following libraries have been installed: - ``` - export BROWSERSTACK_USERNAME= && - export BROWSERSTACK_ACCESS_KEY= - ``` -## Additional Resources -* [Documentation for writing Automate test scripts in Java](https://www.browserstack.com/automate/java) -* [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities) -* [Browsers & mobile devices for selenium testing on BrowserStack](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate) -* [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api) +``` +#Install using gem +gem install cucumber +```