<commit_before>#antr

Asynchronous Node Test Runner

[![Build Status](https://travis-ci.org/holidayextras/node-antr.png?branch=master)](https://travis-ci.org/holidayextras/node-antr)

##Why?
We had the need for a runner which runs tests asynchronously.

##Install
  npm install antr
  
##Usage
Just require the module and you're away!

	var Antr = require('antr');
	
	var run = new Antr({
		dirname: __dirname,
		filter: /test([^\/w]+?)\.js$/
	});

You can pass a callback in as the second parameter if you like, which will callback with err, stats. If you don't give antr a callback it will quit the process for you.

	var Antr = require('antr');

	var run = new Antr({
		dirname: __dirname,
		filter: /test([^\/w]+?)\.js$/
	}, function(err, stats){
		console.log('Tests failed: ', stats.fails);
	});

### Options

#### Required<commit_msg>Adding more info to readme<commit_after>#antr

Asynchronous Node Test Runner

[![Build Status](https://travis-ci.org/holidayextras/node-antr.png?branch=master)](https://travis-ci.org/holidayextras/node-antr)

##Why?
We had the need for a runner which runs tests asynchronously.

##Install
  npm install antr
  
##Usage
Just require the module and you're away!

	var Antr = require('antr');
	
	var run = new Antr({
		dirname: __dirname,
		filter: /test([^\/w]+?)\.js$/
	});

You can pass a callback in as the second parameter if you like, which will callback with err, stats. If you don't give antr a callback it will quit the process for you.

	var Antr = require('antr');

	var run = new Antr({
		dirname: __dirname,
		filter: /test([^\/w]+?)\.js$/
	}, function(err, stats){
		console.log('Tests failed: ', stats.failed);
	});

####Stats contains
* **passed**
* **failed** 
* **total**
* **failRate** - percentage of failed tests
* **failedTests** - array of files
* **passedTests** - array of files
* **timeTaken** - format hh:mm:ss

### Options

#### Required
{'fraction_non_alphanumeric': 0.15712033631108777, 'fraction_numerical': 0.0, 'mean_word_length': 4.0237467018469655, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, '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': '2415971', 'n_tokens_mistral': 669, 'n_tokens_neox': 635, 'n_words': 210}