diff --git a/README.md b/README.md index 26c35ba..86eecb6 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,31 @@ # protractor-browserstack - [Protractor](https://github.com/angular/protractor/) Integration with BrowserStack. -## Setup - -- Clone the repo -- Install dependencies `npm install` -- Update `*.conf.js` files inside the `conf/` directory with your BrowserStack Username and Access Key. (These can be found in the [settings](https://www.browserstack.com/accounts/settings) section on BrowserStack accounts page) -- Alternatively, you can export the environment variables for the Username and Access Key of your BrowserStack account. `export BROWSERSTACK_USERNAME= && export BROWSERSTACK_ACCESS_KEY=` - -### Run the tests +![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780) -- To run single test, run `npm run single` -- To run parallel tests, run `npm run parallel` -- To run local tests, run `npm run local` - - -### Notes - -- The latest version of protractor needs the ‘browserName’ capability mentioned for tests to be executed. -- In order to test on different set of browsers, check out our [code generator](https://www.browserstack.com/automate/python#setting-os-and-browser) +## Setup +* Clone the repo +* Install dependencies `npm install` +* Update `*.conf.js` files inside the `conf/` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings) + +## Running your tests +* To run a single test, run `npm run single` +* To run parallel tests, run `npm run parallel` +* To run local tests, run `npm run local` + +## Notes +* The latest version of protractor needs the `browserName` capability mentioned for tests to be executed +* 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/node#setting-os-and-browser) +* You can export the environment variables for the Username and Access Key of your BrowserStack account + + ``` + export BROWSERSTACK_USERNAME= && + export BROWSERSTACK_ACCESS_KEY= + ``` + +## Additional Resources +* [Documentation for writing automate test scripts in Node](https://www.browserstack.com/automate/node) +* [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities) +* [Browsers & mobile devices for selenium testing on BrowserStack](Browsers & Mobile Devices for Selenium Testing) +* [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api)