wip

Author: MihirR-BS

README.md

@@ -6,13 +6,13 @@ This repo contains samples for running [WebdriverIO](https://webdriver.io/) test
 ## Setup
 
 * Clone the repo `git clone https://github.com/browserstack/browserstack-webdriverio-load-testing-sample.git`.
-* Set `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` as environment variables with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings) 
+* Open the browserstack-load.yaml file and update it with the relevant load test configurations.(https://www.browserstack.com/accounts/settings) 
 * Run `npm i` to install the dependencies.
 * Update the same in `browserstack-load.yaml` file.
 
 ## Running your tests
 
-- To run the sample tests in parallel across the platforms specified in the `browserstack-load.yaml`, run `npx browserstack-cli load run`.
+- To run the sample tests in parallel across the platforms specified in the `browserstack-load.yaml`, Run the given command to start your test: `npx browserstack-cli load run`.
 
 ## Notes
-* You can view your test results on the [BrowserStack Load-Testing dashboard](https://load.browserstack.com/projects)
+* You can view your test results on the [BrowserStack Load Testing dashboard](https://load.browserstack.com/projects)

browserstack-load.yml

@@ -48,9 +48,13 @@ files:
    - wdio.conf.js
 
 # Specify environment variabls in the following manner.
+# sources:
+#  - path/to/env/file  
 # env:
 #  - name: variable1
 #    value: value1
 #  - name: variable2
 #    value: value2
 
+# Set 'headless' to false to run tests in headful mode. This option is supported only when testType is set to WebdriverIO or Playwright.
+headless: false