Skip to content

Commit

Permalink
Merge branch 'master' into gjp/package-json-cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
gpittarelli authored Jun 20, 2018
2 parents a970e7d + cc6a088 commit 6b98eb4
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 21 deletions.
10 changes: 3 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
language: node_js
node_js:
- "4.3"
- "4.0"
- "0.12"
- "0.10"

before_install:
- true && `base64 --decode <<< ZXhwb3J0IEJST1dTRVJTVEFDS19BQ0NFU1NfS0VZPUh5VmZydXJvb3dYb041eGhLZEs2Cg==`

- "6"
- "8"
- "10"
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ npm install browserstack-local

## Example

```node
```js
var browserstack = require('browserstack-local');

//creates an instance of Local
Expand Down Expand Up @@ -42,31 +42,31 @@ Apart from the key, all other BrowserStack Local modifiers are optional. For the

#### Verbose Logging
To enable verbose logging -
```node
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'verbose': 'true' }
```

#### Folder Testing
To test local folder rather internal server, provide path to folder as value of this option -
```node
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'f': '/my/awesome/folder' }
```

#### Force Start
To kill other running Browserstack Local instances -
```node
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'force': 'true' }
```

#### Only Automate
To disable local testing for Live and Screenshots, and enable only Automate -
```node
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'onlyAutomate': 'true' }
```

#### Force Local
To route all traffic via local(your) machine -
```node
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'forceLocal': 'true' }
```

Expand All @@ -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
```js
bs_local_args = { 'key': '<browserstack-accesskey>', '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
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'localIdentifier': 'randomstring' }
```

Expand All @@ -94,14 +94,14 @@ bs_local_args = { 'key': '<browserstack-accesskey>', '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
```js
bs_local_args = { 'key': '<browserstack-accesskey>', '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
```js
bs_local_args = { 'key': '<browserstack-accesskey>', 'verbose': 'true', 'logFile': '/browserstack/logs.txt' }
```

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "browserstack-local",
"version": "1.3.0",
"version": "1.3.3",
"description": "Nodejs bindings for BrowserStack Local",
"engine": "^0.10.44",
"main": "index.js",
Expand All @@ -17,7 +17,7 @@
"author": "BrowserStack",
"license": "MIT",
"dependencies": {
"https-proxy-agent": "^1.0.0",
"https-proxy-agent": "^2.2.1",
"is-running": "^2.0.0"
},
"devDependencies": {
Expand All @@ -33,7 +33,7 @@
"bugs": "https://github.com/browserstack/browserstack-local-nodejs/issues",
"homepage": "https://github.com/browserstack/browserstack-local-nodejs",
"repository": {
"type" : "git",
"url" : "https://github.com/browserstack/browserstack-local-nodejs.git"
"type": "git",
"url": "https://github.com/browserstack/browserstack-local-nodejs.git"
}
}

0 comments on commit 6b98eb4

Please sign in to comment.