diff --git a/README.md b/README.md index f48f6a6..38f16e1 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,24 @@ npm install browserstack-local ## Example -``` +```node var browserstack = require('browserstack-local'); -# creates an instance of Local +//creates an instance of Local var bs_local = new browserstack.Local(); -# replace with your key. You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY". +// replace with your key. You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY". var bs_local_args = { 'key': '' }; -# starts the Local instance with the required arguments +// starts the Local instance with the required arguments bs_local.start(bs_local_args, function() { console.log("Started BrowserStackLocal"); }); -# check if BrowserStack local instance is running +// check if BrowserStack local instance is running console.log(bs_local.isRunning()); -# stop the Local instance +// stop the Local instance bs_local.stop(function() { console.log("Stopped BrowserStackLocal"); }); @@ -42,31 +42,31 @@ Apart from the key, all other BrowserStack Local modifiers are optional. For the #### Verbose Logging To enable verbose logging - -``` +```node bs_local_args = { 'key': '', 'v': 'true' } ``` #### Folder Testing To test local folder rather internal server, provide path to folder as value of this option - -``` +```node bs_local_args = { 'key': '', 'f': '/my/awesome/folder' } ``` #### Force Start To kill other running Browserstack Local instances - -``` +```node bs_local_args = { 'key': '', 'force': 'true' } ``` #### Only Automate To disable local testing for Live and Screenshots, and enable only Automate - -``` +```node bs_local_args = { 'key': '', 'onlyAutomate': 'true' } ``` #### Force Local To route all traffic via local(your) machine - -``` +```node bs_local_args = { 'key': '', 'forcelocal': 'true' } ``` @@ -78,13 +78,13 @@ 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 -``` +```node bs_local_args = { 'key': '', 'proxyHost': '127.0.0.1', 'proxyPort': '8000', 'proxyUser': 'user', 'proxyPass': 'password' } ``` #### Local Identifier If doing simultaneous multiple local testing connections, set this uniquely for different processes - -``` +```node bs_local_args = { 'key': '', 'localIdentifier': 'randomstring' } ``` @@ -94,14 +94,14 @@ bs_local_args = { 'key': '', 'localIdentifier': 'randoms 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 - -``` +```node bs_local_args = { 'key': '', '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 - -``` +```node bs_local_args = { 'key': '', 'v': 'true', 'logfile': '/browserstack/logs.txt' } ```