Skip to content

Commit 06b5563

Browse files
author
cloudhead
committed
(doc) updated README
1 parent 4079f57 commit 06b5563

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,18 @@ synopsis
1717
var vows = require('vows'),
1818
assert = require('assert');
1919

20-
vows.describe('Deep Thought').addVows(function () {
21-
question('what is the answer to the universe?').addVow(function (answer) {
22-
assert.equals(answer, 42);
23-
}, 'it should know the answer to the ultimate question of life');
24-
});
20+
vows.describe('Deep Thought').addVows({
21+
'An instance of DeepThought': {
22+
topic: new DeepThought,
2523

26-
In the example above, `question()` would be a function which returns an `EventEmitter`.
27-
When the `"success"` event is emitted, the function passed to `addVow` is run,
28-
and the results output to the console.
24+
'should know the answer to the ultimate question of life': function (deepThought) {
25+
assert.equal (deepThought.question('what is the answer to the universe?'), 42);
26+
}
27+
}
28+
});
2929

30-
Vows are run as soon as the promise completes, so the order in which they are run is undefined.
30+
Documenation coming soon. For now, have a look at the tests in <http://github.com/cloudhead/resourcer> to
31+
get an idea.
3132

3233
installation
3334
------------
@@ -69,7 +70,7 @@ writing specs
6970
}
7071
}
7172
}
72-
});
73+
}).run();
7374

7475
assertion macros
7576
----------------

0 commit comments

Comments
 (0)