Skip to content

Commit 84c8cad

Browse files
Ankit098francisf
authored andcommitted
add: deprecation note to readme
1 parent 490e923 commit 84c8cad

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

README.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
# WebdriverIO Browserstack Service
1+
# Deprecation Note
2+
3+
> The changes done as a part of this fork have now been merged into [@wdio/browserstack-service](https://www.npmjs.com/package/@wdio/browserstack-service), so we will be deprecating this package. Please install the service using:
4+
5+
```sh
6+
npm install @wdio/browserstack-service --save-dev
7+
```
8+
9+
---
10+
11+
<s># WebdriverIO Browserstack Service
212

313
> The official BrowserStack WebdriverIO service that integrates your WebdriverIO test suite with BrowserStack.
414
@@ -64,15 +74,15 @@ List of available local testing modifiers to be passed as opts:
6474
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
6575

6676
```js
67-
opts = { localIdentifier: "randomstring" };
77+
opts = { localIdentifier: 'randomstring' };
6878
```
6979

7080
#### Verbose Logging
7181

7282
To enable verbose logging -
7383

7484
```js
75-
opts = { verbose: "true" };
85+
opts = { verbose: 'true' };
7686
```
7787

7888
Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
@@ -82,31 +92,31 @@ Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
8292
To route all traffic via local(your) machine -
8393

8494
```js
85-
opts = { forceLocal: "true" };
95+
opts = { forceLocal: 'true' };
8696
```
8797

8898
#### Folder Testing
8999

90100
To test local folder rather internal server, provide path to folder as value of this option -
91101

92102
```js
93-
opts = { f: "/my/awesome/folder" };
103+
opts = { f: '/my/awesome/folder' };
94104
```
95105

96106
#### Force Start
97107

98108
To kill other running Browserstack Local instances -
99109

100110
```js
101-
opts = { force: "true" };
111+
opts = { force: 'true' };
102112
```
103113

104114
#### Only Automate
105115

106116
To disable local testing for Live and Screenshots, and enable only Automate -
107117

108118
```js
109-
opts = { onlyAutomate: "true" };
119+
opts = { onlyAutomate: 'true' };
110120
```
111121

112122
#### Proxy
@@ -120,10 +130,10 @@ To use a proxy for local testing -
120130

121131
```js
122132
opts = {
123-
proxyHost: "127.0.0.1",
124-
proxyPort: "8000",
125-
proxyUser: "user",
126-
proxyPass: "password",
133+
proxyHost: '127.0.0.1',
134+
proxyPort: '8000',
135+
proxyUser: 'user',
136+
proxyPass: 'password',
127137
};
128138
```
129139

@@ -138,10 +148,10 @@ To use local proxy in local testing -
138148

139149
```js
140150
opts = {
141-
localProxyHost: "127.0.0.1",
142-
localProxyPort: "8000",
143-
localProxyUser: "user",
144-
localProxyPass: "password",
151+
localProxyHost: '127.0.0.1',
152+
localProxyPort: '8000',
153+
localProxyUser: 'user',
154+
localProxyPass: 'password',
145155
};
146156
```
147157

@@ -152,7 +162,7 @@ To use PAC (Proxy Auto-Configuration) in local testing -
152162
- pac-file: PAC (Proxy Auto-Configuration) file’s absolute path
153163

154164
```js
155-
opts = { "pac-file": "<pac_file_abs_path>" };
165+
opts = { 'pac-file': '<pac_file_abs_path>' };
156166
```
157167

158168
#### Binary Path
@@ -161,7 +171,7 @@ By default, BrowserStack local wrappers try downloading and executing the latest
161171
Path to specify local Binary path -
162172

163173
```js
164-
opts = { binarypath: "/path/to/binary" };
174+
opts = { binarypath: '/path/to/binary' };
165175
```
166176

167177
#### Logfile
@@ -170,9 +180,9 @@ To save the logs to the file while running with the '-v' argument, you can speci
170180
To specify the path to file where the logs will be saved -
171181

172182
```js
173-
opts = { verbose: "true", logFile: "./local.log" };
183+
opts = { verbose: 'true', logFile: './local.log' };
174184
```
175185

176186
---
177187

178-
For more information on WebdriverIO see the [homepage](https://webdriver.io).
188+
For more information on WebdriverIO see the [homepage](https://webdriver.io). </s>

0 commit comments

Comments
 (0)