Skip to content

Commit a22dded

Browse files
committed
Merge pull request #14 from browserstack/tr4n2uil-patch-1
Update installation
2 parents 67c5283 + aacc24c commit a22dded

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@
55
Java bindings for BrowserStack Local.
66

77
## Installation
8-
```
9-
mvn install browserstack-local
8+
9+
Add this dependency to your project's POM:
10+
```xml
11+
<dependency>
12+
<groupId>com.browserstack</groupId>
13+
<artifactId>browserstack-local-java</artifactId>
14+
<version>0.3.0</version>
15+
</dependency>
1016
```
1117

1218
## Example
1319

14-
```
20+
```java
1521
import com.browserstack.local.Local;
1622

1723
# creates an instance of Local
@@ -37,31 +43,31 @@ Apart from the key, all other BrowserStack Local modifiers are optional. For the
3743

3844
#### Verbose Logging
3945
To enable verbose logging -
40-
```
46+
```java
4147
bsLocalArgs.put("v", "true");
4248
```
4349

4450
#### Folder Testing
4551
To test local folder rather internal server, provide path to folder as value of this option -
46-
```
52+
```java
4753
bsLocalArgs.put("f", "/my/awesome/folder");
4854
```
4955

5056
#### Force Start
5157
To kill other running Browserstack Local instances -
52-
```
58+
```java
5359
bsLocalArgs.put("force", "true");
5460
```
5561

5662
#### Only Automate
5763
To disable local testing for Live and Screenshots, and enable only Automate -
58-
```
64+
```java
5965
bsLocalArgs.put("onlyAutomate", "true");
6066
```
6167

6268
#### Force Local
6369
To route all traffic via local(your) machine -
64-
```
70+
```java
6571
bsLocalArgs.put("forcelocal", "true");
6672
```
6773

@@ -73,7 +79,7 @@ To use a proxy for local testing -
7379
* proxyUser: Username for connecting to proxy (Basic Auth Only)
7480
* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
7581

76-
```
82+
```java
7783
bsLocalArgs.put("proxyHost", "127.0.0.1");
7884
bsLocalArgs.put("proxyPort", "8000");
7985
bsLocalArgs.put("proxyUser", "user");
@@ -82,7 +88,7 @@ bsLocalArgs.put("proxyPass", "password");
8288

8389
#### Local Identifier
8490
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
85-
```
91+
```java
8692
bsLocalArgs.put("localIdentifier", "randomstring");
8793
```
8894

@@ -92,14 +98,14 @@ bsLocalArgs.put("localIdentifier", "randomstring");
9298

9399
By default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.
94100
Path to specify local Binary path -
95-
```
101+
```java
96102
bsLocalArgs.put("binarypath", "/browserstack/BrowserStackLocal");
97103
```
98104

99105
#### Logfile
100106
To save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory.
101107
To specify the path to file where the logs will be saved -
102-
```
108+
```java
103109
bsLocalArgs.put("v", "true");
104110
bsLocalArgs.put("logfile", "/browserstack/logs.txt");
105111
```

0 commit comments

Comments
 (0)