<commit_before># bunyip

Automate client-side unit testing in real browsers using the CLI

## Getting Started
Install the module with: `npm install -g bunyip`. This is a CLI tool so it needs to be globally installed.

### BrowserStack account
In order for bunyip to flex its real muscle I recommend you get a paid [BrowserStack account])(http://www.browserstack.com/pricing) as all paid accounts have access to their API. Without the API you'll need to connect your own slave browsers to bunyip.

### localhost sharing service
If you wish to test on devices that are not part of your local network you'll be required to setup a tunneling service. I recommend [pagekite](https://pagekite.net/support/quickstart/) as it gives you a nice free chunk of data and allows you to specify a reusable subdomain. [Showoff.io](https://showoff.io/) is another good option.

### Setup the config.js file
If you don't wish to use BrowserStack or a localhost sharing service you can skip this step. If you look inside the lib folder you'll see a `config-template.js` file, copy it and rename to config.js. Edit the values to whatever you need it to be.

```js
var config = config || {};

config.browserstack = {
	username: "foo", // Your BrowserStack username
	password: "<PASSWORD>", // Your BrowserStack password
	version: 2
};

// The tunneling service I use is https://pagekite.net/support/quickstart/ 
// You can easily use another service lke showoff.io only requirement is that you can specify a fixed url name
config.port = " 9000 ";
config.tunnellink = "bunyip.pagekite.me/"; // The subdomain that the tunnel can be access by
// This is the command that nodejs will execute using child_process.exec
// If you were using showoff.io the below command would be "show" + config.port
config.tunnel = "pagekite.py" + config.port + config.tunnellink;<commit_msg>Fix markdown link in readme<commit_after># bunyip

Automate client-side unit testing in real browsers using the CLI

## Getting Started
Install the module with: `npm install -g bunyip`. This is a CLI tool so it needs to be globally installed.

### BrowserStack account
In order for bunyip to flex its real muscle I recommend you get a paid [BrowserStack account](http://www.browserstack.com/pricing) as all paid accounts have access to their API. Without the API you'll need to connect your own slave browsers to bunyip.

### localhost sharing service
If you wish to test on devices that are not part of your local network you'll be required to setup a tunneling service. I recommend [pagekite](https://pagekite.net/support/quickstart/) as it gives you a nice free chunk of data and allows you to specify a reusable subdomain. [Showoff.io](https://showoff.io/) is another good option.

### Setup the config.js file
If you don't wish to use BrowserStack or a localhost sharing service you can skip this step. If you look inside the lib folder you'll see a `config-template.js` file, copy it and rename to config.js. Edit the values to whatever you need it to be.

```js
var config = config || {};

config.browserstack = {
	username: "foo", // Your BrowserStack username
	password: "<PASSWORD>", // Your BrowserStack password
	version: 2
};

// The tunneling service I use is https://pagekite.net/support/quickstart/ 
// You can easily use another service lke showoff.io only requirement is that you can specify a fixed url name
config.port = " 9000 ";
config.tunnellink = "bunyip.pagekite.me/"; // The subdomain that the tunnel can be access by
// This is the command that nodejs will execute using child_process.exec
// If you were using showoff.io the below command would be "show" + config.port
config.tunnel = "pagekite.py" + config.port + config.tunnellink;
{'fraction_non_alphanumeric': 0.08007549204637368, 'fraction_numerical': 0.0026961445133459154, 'mean_word_length': 4.117241379310345, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2782050', 'n_tokens_mistral': 1054, 'n_tokens_neox': 994, 'n_words': 519}