Skip to content

Commit a49459f

Browse files
committed
updated readme
1 parent 78a2c48 commit a49459f

File tree

1 file changed

+1
-102
lines changed

1 file changed

+1
-102
lines changed

README.md

Lines changed: 1 addition & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -126,105 +126,4 @@ Default: `true`
126126

127127
----
128128

129-
For more information on WebdriverIO see the [homepage](https://webdriver.io).
130-
WebdriverIO LambdaTest Service
131-
========================
132-
133-
[![WDIO health check](https://github.com/LambdaTest/wdio-lambdatest-service/actions/workflows/healthcheck.yml/badge.svg?branch=master)](https://github.com/LambdaTest/wdio-lambdatest-service/actions/workflows/healthcheck.yml)
134-
135-
> A WebdriverIO service that manages tunnel and job metadata for LambdaTest users.
136-
137-
## Installation
138-
139-
```bash
140-
npm i wdio-lambdatest-service --save-dev
141-
```
142-
143-
Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html)
144-
145-
146-
## Configuration
147-
148-
WebdriverIO has LambdaTest support out of the box. You should simply set `user` and `key` in your `wdio.conf.js` file. To enable the feature for app automation, set `product: 'appAutomation'` in your `wdio.conf.js` file. This service plugin provides supports for [LambdaTest Tunnel](https://www.lambdatest.com/support/docs/troubleshooting-lambda-tunnel/). Set `tunnel: true` also to activate this feature.
149-
150-
```js
151-
// wdio.conf.js
152-
exports.config = {
153-
// ...
154-
user: process.env.LT_USERNAME,
155-
key: process.env.LT_ACCESS_KEY,
156-
logFile : './logDir/api.log',
157-
services: [
158-
['lambdatest', {
159-
tunnel: true
160-
}]
161-
],
162-
// ...
163-
};
164-
```
165-
166-
## Options
167-
168-
In order to authorize to the LambdaTest service your config needs to contain a [`user`](https://webdriver.io/docs/options.html#user) and [`key`](https://webdriver.io/docs/options.html#key) option.
169-
170-
### tunnel
171-
Set this to true to enable routing connections from LambdaTest cloud through your computer. You will also need to set `tunnel` to true in browser capabilities.
172-
173-
Type: `Boolean`<br>
174-
Default: `false`
175-
176-
### lambdatestOpts
177-
Specified optional will be passed down to LambdaTest Tunnel. See [this list](https://www.lambdatest.com/support/docs/lambda-tunnel-modifiers/) for details.
178-
179-
Type: `Object`<br>
180-
Default: `{}`
181-
182-
### preferScenarioName
183-
Cucumber only. Set the session name to the Scenario name if only a single Scenario ran.
184-
Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
185-
186-
Type: `Boolean`<br />
187-
Default: `false`
188-
189-
### sessionNameFormat
190-
Customize the session name format.
191-
192-
Type: `Function`<br />
193-
Default (Cucumber/Jasmine): `(config, capabilities, suiteTitle) => suiteTitle`<br />
194-
Default (Mocha): `(config, capabilities, suiteTitle, testTitle) => suiteTitle + ' - ' + testTitle`
195-
196-
### sessionNameOmitTestTitle
197-
Mocha only. Do not append the test title to the session name.
198-
199-
Type: `Boolean`<br />
200-
Default: `false`
201-
202-
### sessionNamePrependTopLevelSuiteTitle
203-
Mocha only. Prepend the top level suite title to the session name.
204-
205-
Type: `Boolean`<br />
206-
Default: `false`
207-
208-
### setSessionName
209-
Automatically set the session name.
210-
211-
Type: `Boolean`<br />
212-
Default: `true`
213-
214-
### setSessionStatus
215-
Automatically set the session status (passed/failed).
216-
217-
Type: `Boolean`<br />
218-
Default: `true`
219-
220-
221-
## Steps to compile and publish
222-
1. git clone this repository.
223-
2. run "npm install"
224-
3. run "npm run build"
225-
4. Steps to Publish: run "npm login"
226-
5. run "npm publish --access public"
227-
228-
----
229-
230-
For more information on WebdriverIO see the [homepage](https://webdriver.io).
129+
For more information on WebdriverIO see the [homepage](https://webdriver.io).

0 commit comments

Comments
 (0)