Permalink
Browse files

Basic Readme file

  • Loading branch information...
1 parent 1df6326 commit e149bd0b2ca984e9859d5a416bab79c320c1310a Joel Plane committed Jun 18, 2011
Showing with 48 additions and 0 deletions.
  1. +48 −0 README.md
View
@@ -0,0 +1,48 @@
+TestNode
+========
+
+A testing library/framework for Node.js
+
+TestNode aims to be unobtrusive and unassuming about the environment
+in which it will run. That's the goal - we will no-doubt fall short
+of this goal somewhere, but we'll try our best.
+
+It's a BDD-esc library in it's syntax, but that's about as far as it
+goes in terms of BDD.
+
+Example
+-------
+
+**Basic Syntax**:
+
+ var test = require('testnode')();
+ test.onFailureExitNonZero();
+
+ test.context("Example Test Suite", function() {
+ this.context("Example Sub-Context", function() {
+ this.it("Basic Test Example", function(test) {
+ test.assert(true);
+ test.done();
+ });
+ });
+ });
+
+**Executing tests**:
+
+ node examples/basicTest.js
+
+OR *coming soon*:
+
+ testnode testsDirectory
+
+See the examples directory for more examples.
+
+Installation
+------------
+
+Install with npm:
+
+ npm install testnode
+
+More doco coming soon :)
+

0 comments on commit e149bd0

Please sign in to comment.