From 1b5843489cdc0df5bec74735308391964baacc53 Mon Sep 17 00:00:00 2001 From: Vibhaj Rajan Date: Tue, 31 May 2016 18:02:49 +0530 Subject: [PATCH 1/4] Update installation --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ab20b65..e492052 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,15 @@ Java bindings for BrowserStack Local. ## Installation + +Add the following to pom.xml ``` -mvn install browserstack-local + + + com.browserstack + browserstack-local-java + 0.3.0 + ``` ## Example From 5868e7382ea80e4f265af197418371f23324907f Mon Sep 17 00:00:00 2001 From: Vibhaj Rajan Date: Tue, 31 May 2016 18:22:39 +0530 Subject: [PATCH 2/4] Updated sentence --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e492052..00610a9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Java bindings for BrowserStack Local. ## Installation -Add the following to pom.xml +Add this dependency to your project's POM: ``` From a4d81ea666326ca12e843d4628d67ebda7ab4529 Mon Sep 17 00:00:00 2001 From: Vibhaj Rajan Date: Tue, 31 May 2016 18:23:37 +0530 Subject: [PATCH 3/4] removed comment in pom --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 00610a9..6c59e78 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,7 @@ Java bindings for BrowserStack Local. ## Installation Add this dependency to your project's POM: -``` - +```xml com.browserstack browserstack-local-java From aacc24c383545cf6736c0c9302b6bf4b23e1ac25 Mon Sep 17 00:00:00 2001 From: Vibhaj Rajan Date: Tue, 31 May 2016 18:24:58 +0530 Subject: [PATCH 4/4] Added highlighting --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6c59e78..4bbc25f 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Add this dependency to your project's POM: ## Example -``` +```java import com.browserstack.local.Local; # creates an instance of Local @@ -43,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"); ``` @@ -79,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"); @@ -88,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"); ``` @@ -98,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"); ```