Skip to content

Commit

Permalink
minor modifications
Browse files Browse the repository at this point in the history
  • Loading branch information
clarkbox committed May 5, 2012
1 parent f32c57b commit 9939833
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,16 @@ This script is currently compatible with:
testswarm-browserstack.cli.js --swarmUrl "http://swarm.jquery.org" --swarmRunUrl "http://swarm.jquery.org/run/exampleClientName" --user "BrowserStackUser" --pass "myBrowserStackPass@#$" --run --kill
</pre>

This above command will spawn (via `--run`) AND kill (via `--kill`) BrowserStack workers as indicated by the TestSwarm `swarmstate` API. This command should be executed on a regular interval, via cron or other scheduler - for more short term requirements, see [node-cli-repeater](https://github.com/clarkbox/node-repeater).
This above command will spawn (via `--run`) AND kill (via `--kill`) BrowserStack workers as indicated by the TestSwarm `swarmstate` API. This command should be executed on a regular interval, via cron or other scheduler - for more short term requirements, see [cli-repeat](https://github.com/clarkbox/cli-repeat) (command line utility to repeat a command at regular interval).


In most cases, the `--kill` option should always accompany the `--run` option. This will ensure workers are not running idle (although eventually browserstack will still terminate idle workers after `clientTimeout`).

## This repo contains two parts:
## This repo contains two (main) parts:

1. [testswarm-browserstack.js](https://github.com/clarkbox/testswarm-browserstack/blob/master/testswarm-browserstack.js) - Abstraction of TestSwarm API, and Scott González's BrowserStack API. Use it to spawn BrowserStack workers to keep your TestSwarm populated.
1. [testswarm-browserstack.js](https://github.com/clarkbox/testswarm-browserstack/blob/master/testswarm-browserstack.js) - Abstraction of TestSwarm API, and Scott González's BrowserStack API. Use it to spawn BrowserStack workers to keep your TestSwarm populated from your own JS code.
2. [testswarm-browserstack.cli.js](https://github.com/clarkbox/testswarm-browserstack/blob/master/testswarm-browserstack.cli.js) - nodejs CLI interface wrapper around it all. Allows for scripted or easier manual invocation of browsers.

### Dependencies:
Install via `npm install`.

## testswarm-browserstack.js
--------------------------------------
### options([options])
Expand Down Expand Up @@ -71,8 +68,6 @@ Kill a single worker. Calls BrowserStack.terminateWorker()
### killAll()
Kill all workers running on BrowserStack.



## testswarm-browserstack.cli.js
--------------------------------------
this is a nodejs CLI interface wrapper around testswarm-browserstack.js. Use --help for all you need to know (see above for usage example):
Expand Down

0 comments on commit 9939833

Please sign in to comment.