Skip to content

Commit

Permalink
Update README and package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Kami committed Mar 26, 2011
1 parent 6098c5a commit 8636a4b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 7 deletions.
44 changes: 38 additions & 6 deletions README.md
Expand Up @@ -3,25 +3,57 @@ Whiskey

Whiskey is a simple test runner for NodeJS applications.

Features
========

* Each test file is run in a separate process
* Support for a test file timeout
* Support for a "failfast mode" (runner exits after a first failure)
* Nicely formatted output (colors!)

TODO
====

* Support for "TAP" output (http://testanything.org/wiki/index.php/Main_Page)

Screenshot
==========
![Console output](https://img.skitch.com/20110326-j5rk1damqt4yr7adw5mjqbqjd.jpg)

Dependencies
===========

- optparse-js
- async
- sprintf
* optparse-js
* async
* sprintf

Changes
=======

* 26.03.2011 - v0.2.0
* Add support for the failfast mode (runner exists after a first failure)
* User can specify custom test timeout by passing in the --timeout argument
* Add support for a setUp and tearDown function
* Add colors to the output
* Now each test file must export all the test functions so the runner can
iterate over them

* 25.03.2011 - v0.1.0
* Initial release
* Initial release (refactor module out from Cast and move it into a separate
project)

Installation
============

TODO.
Install it using npm:
npm install whiskey

Usage
=====

TODO.
whiskey --tests <test files> [options]

Example
=======

For examples check the `examples` folder.
2 changes: 1 addition & 1 deletion package.json
@@ -1,7 +1,7 @@
{
"name": "whiskey",
"description": "A simple test runner for NodeJS applications.",
"version": "0.1.0",
"version": "0.2.0",
"author": "Cloudkick, Inc. <tomaz+npm@cloudkick.com> http://www.cloudkick.com",
"keywords": [ "whiskey", "tests", "test runner", "testing", "tdd" ],
"homepage": "https://github.com/cloudkick/whiskey",
Expand Down

0 comments on commit 8636a4b

Please sign in to comment.