Skip to content

Commit 6831448

Browse files
committed
readme
1 parent 81592ce commit 6831448

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ To run unit tests, you can take the following steps:
231231
2. Run `npm test` to run all test files.
232232
3. Run `npm run test-vitest` to run only tests written using Vitest.
233233
4. Run `npm run test-mocha` to run only tests written using Mocha.
234-
4. (For cross-browser testing) Run `npm run test-xbrowser` to run tests in many browsers via BrowserStack.
234+
4. (For cross-browser testing) Run `npm run test-browser-browserstack` to run browser tests via BrowserStack, or `npm run test-browser-local` to run them locally.
235235
5. Resolve any tests that fail before continuing with your contribution.
236236

237237
This information is relevant only if you plan on contributing to the SDK itself.
@@ -243,14 +243,20 @@ npm install
243243
# Run unit tests.
244244
npm test
245245

246-
# Run unit tests in many browsers, currently via BrowserStack.
246+
# Run browser tests locally.
247+
npm run test-browser-local
248+
249+
# Run browser tests via BrowserStack.
247250
# For this to work, the following environment variables must be set:
248-
# - BROWSER_STACK_USERNAME
249-
# - BROWSER_STACK_PASSWORD
250-
npm run test-xbrowser
251+
# - BROWSERSTACK_USERNAME
252+
# - BROWSERSTACK_ACCESS_KEY
253+
npm run test-browser-browserstack
254+
255+
# Run UMD bundle tests via BrowserStack.
256+
npm run test-umd-browserstack
251257
```
252258

253-
[/.github/workflows/javascript.yml](/.github/workflows/javascript.yml) contains the definitions for `BROWSER_STACK_USERNAME` and `BROWSER_STACK_ACCESS_KEY` used in the GitHub Actions CI pipeline. When developing locally, you must provide your own credentials in order to run `npm run test-xbrowser`. You can register for an account for free on [the BrowserStack official website here](https://www.browserstack.com/).
259+
[/.github/workflows/javascript.yml](/.github/workflows/javascript.yml) contains the definitions for `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` used in the GitHub Actions CI pipeline. When developing locally, you must provide your own credentials in order to run `npm run test-browser-browserstack`. You can register for an account for free on [the BrowserStack official website here](https://www.browserstack.com/).
254260

255261
### Contributing
256262

0 commit comments

Comments
 (0)