Skip to content

Commit f6e94f9

Browse files
authored
Merge pull request #2 from yashLadha/master
Updated readme to include instructions for development build
2 parents 9bdf3ae + 54647dc commit f6e94f9

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,26 @@ This plugin integrates [TestCafe](http://devexpress.github.io/testcafe) with the
66

77
## Install
88

9-
```sh
10-
npm install testcafe-browser-provider-browserstack
9+
Step 1: Clone the repo
10+
```bash
11+
git clone https://github.com/browserstack/testcafe-browser-provider-browserstack.git
12+
```
13+
14+
Step 2: Go into the directory
15+
```bash
16+
cd testcafe-browser-provider-browserstack
17+
```
18+
Step 3: Install the dependencies
19+
```bash
20+
npm install (use lts version to avoid breaking changes)
21+
```
22+
Step 4: Gulp build the module
23+
```bash
24+
./node_modules/.bin/gulp build
25+
```
26+
Step 5: Link the package globally, for consumption by testcafe
27+
```bash
28+
npm link
1129
```
1230

1331
## Usage
@@ -52,7 +70,7 @@ Proxy options can be passed via environment variables.
5270
- `BROWSERSTACK_LOCAL_PROXY` - a string that specifies a proxy for the local web server. It should have the following structure: `user:pass@proxyHostName:port`,
5371
- `BROWSERSTACK_FORCE_PROXY` - if it's not empty, forces all traffic of BrowserStack local binary to go through the proxy,
5472
- `BROWSERSTACK_FORCE_LOCAL` - if it's not empty, forces all traffic of BrowserStack local binary to go through the local machine
55-
- `BROWSERSTACK_NO_LOCAL` - If it's not empty, forces all traffic of BrowserStack to go over public internet
73+
- `BROWSERSTACK_NO_LOCAL` - If it's not empty, forces all traffic of BrowserStack to go over public internet
5674

5775
Example:
5876

@@ -137,23 +155,23 @@ testcafe browserstack:chrome test.js
137155
```
138156

139157
## Other BrowserStack Options
140-
158+
141159
BrowserStack Automate allows you to provide options for its internal Selenium Grid in the form of key-value pairs called [capabilities](https://www.browserstack.com/automate/capabilities).
142-
160+
143161
To specify BrowserStack capabilities via the TestCafe BrowserStack provider, use environment variables. This provider supports the following capabilities:
144-
162+
145163
Capability | Environment Variable
146164
-------------------------- | --------------------
147165
`browserstack.debug` | `BROWSERSTACK_DEBUG`
148166
`browserstack.console` | `BROWSERSTACK_CONSOLE`
149167
`browserstack.networkLogs` | `BROWSERSTACK_NETWORK_LOGS`
150168
`browserstack.video` | `BROWSERSTACK_VIDEO`
151169
`browserstack.timezone` | `BROWSERSTACK_TIMEZONE`
152-
170+
153171
Refer to the [BrowserStack documentation](https://www.browserstack.com/automate/capabilities) for information about the values you can specify.
154-
172+
155173
**Example**
156-
174+
157175
```sh
158176
export BROWSERSTACK_DEBUG="true"
159177
export BROWSERSTACK_TIMEZONE="UTC"

0 commit comments

Comments
 (0)