Skip to content

Update installation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 31, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@
Java bindings for BrowserStack Local.

## Installation
```
mvn install browserstack-local

Add this dependency to your project's POM:
```xml
<dependency>
<groupId>com.browserstack</groupId>
<artifactId>browserstack-local-java</artifactId>
<version>0.3.0</version>
</dependency>
```

## Example

```
```java
import com.browserstack.local.Local;

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

#### Verbose Logging
To enable verbose logging -
```
```java
bsLocalArgs.put("v", "true");
```

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

#### Force Start
To kill other running Browserstack Local instances -
```
```java
bsLocalArgs.put("force", "true");
```

#### Only Automate
To disable local testing for Live and Screenshots, and enable only Automate -
```
```java
bsLocalArgs.put("onlyAutomate", "true");
```

#### Force Local
To route all traffic via local(your) machine -
```
```java
bsLocalArgs.put("forcelocal", "true");
```

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

```
```java
bsLocalArgs.put("proxyHost", "127.0.0.1");
bsLocalArgs.put("proxyPort", "8000");
bsLocalArgs.put("proxyUser", "user");
Expand All @@ -82,7 +88,7 @@ bsLocalArgs.put("proxyPass", "password");

#### Local Identifier
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
```
```java
bsLocalArgs.put("localIdentifier", "randomstring");
```

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

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.
Path to specify local Binary path -
```
```java
bsLocalArgs.put("binarypath", "/browserstack/BrowserStackLocal");
```

#### Logfile
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.
To specify the path to file where the logs will be saved -
```
```java
bsLocalArgs.put("v", "true");
bsLocalArgs.put("logfile", "/browserstack/logs.txt");
```
Expand Down