Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Zero Cho committed Oct 11, 2018
1 parent 8d3beb9 commit b0628e8
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Expand Up @@ -15,7 +15,7 @@ Before using this plugin, save the BrowserStack username and access key to envir
Project name and build name will be displayed in BrowserStack if you set the environment variables `BROWSERSTACK_PROJECT_NAME` and `BROWSERSTACK_BUILD_ID`.

If you have troubles starting multiple browsers at once, or get `browserstack-local` related errors like [#27](https://github.com/DevExpress/testcafe-browser-provider-browserstack/issues/27),
try setting the `BROWSERSTACK_PARALLEL_RUNS` environment variable to the number of browsers you want to run simultaneously, or to 1 if you want to run just one browser.
try setting the `BROWSERSTACK_PARALLEL_RUNS` environment variable to the number of browsers you want to run simultaneously, or to 1 if you want to run just one browser.

You can determine the available browser aliases by running
```
Expand Down Expand Up @@ -45,27 +45,37 @@ Tip: you can skip version (`@53.0`) or/and OS name (`:Windows 10`).
Proxy options can be passed via envrionment variables.

- `BROWSERSTACK_PROXY` - a string that specifies a proxy for the Browserstack local binary. It should have the following structure: `user:pass@proxyHostName:port`,
- `BROWERSTACK_LOCAL_PROXY` - a string that specifies a proxy for the local web server. It should have the following structure: `user:pass@proxyHostName:port`,
- `BROWERSTACK_LOCAL_PROXY` - a string that specifies a proxy for the local web server. It should have the following structure: `user:pass@proxyHostName:port`,
- `BROWSERSTACK_FORCE_PROXY` - if it's not empty, forces all traffic of Browserstack local binary to go through the proxy,
- `BROWSERSTACK_FORCE_LOCAL` - if it's not empty, forces all traffic of Browserstack local binary to go through the local machine

## Browserstack JS Testing and Browserstack Automate
## Browserstack JS Testing and Browserstack Automate
Browserstack offers two APIs for browser testing:
- [Browserstack JS Testing](https://www.browserstack.com/javascript-testing-api)
- [Browserstack Automate](https://www.browserstack.com/automate)
JS testing supports more types of devices (compare: [JS Testing devices](https://www.browserstack.com/list-of-browsers-and-platforms?product=js_testing)
vs [Automate devices](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate)),
while Automate allows for much longer tests ([2 hours](https://www.browserstack.com/automate/timeouts) vs [30 minutes](https://github.com/browserstack/api#timeout300))

JS testing supports more types of devices (compare: [JS Testing devices](https://www.browserstack.com/list-of-browsers-and-platforms?product=js_testing)
vs [Automate devices](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate)),
while Automate allows for much longer tests ([2 hours](https://www.browserstack.com/automate/timeouts) vs [30 minutes](https://github.com/browserstack/api#timeout300))
and provides some additional features (like the window resizing functionality).
TestCafe uses the JS Testing API by default. In order to use Browserstack Automate,

TestCafe uses the JS Testing API by default. In order to use Browserstack Automate,
set the `BROWSERSTACK_USE_AUTOMATE` environment variable to `1`.

## Setting display resolution

To set the display resolution, use the `BROWSERSTACK_DISPLAY_RESOLUTION` environment variable.
Valid resolutions can be found [here](https://github.com/browserstack/api#resolution).

## Extra capabilities

Browserstack has a few more custom capabilities. You can find the expected values [here](https://www.browserstack.com/automate/capabilities).

- `BROWSERSTACK_DEBUG`
- `BROWSERSTACK_CONSOLE`
- `BROWSERSTACK_NETWORK_LOGS`
- `BROWSERSTACK_VIDEO`
- `BROWSERSTACK_TIMEZONE`

## Author
Developer Express Inc. (https://devexpress.com)

0 comments on commit b0628e8

Please sign in to comment.