Browse files

Update readme with list of supported matchers

  • Loading branch information...
1 parent 3f8a672 commit 199ebcc12d01f37ef30280239bc07f82bb2a8e1a @joshuaclayton committed Jun 6, 2010
Showing with 11 additions and 1 deletion.
  1. +11 −1 README.markdown
View
12 README.markdown
@@ -6,7 +6,7 @@ Let's face it: [QUnit](http://github.com/jquery/qunit) is pretty awesome, but ju
I don't have the patience to write my own JS testing framework so I figured I'd piggyback off of what QUnit provides.
-## Examples
+## Example
describe("SpecIt", function() {
it("should match on inclusion", function() {
@@ -23,6 +23,16 @@ I don't have the patience to write my own JS testing framework so I figured I'd
});
});
+## Supported Matchers
+
+* include (checks presence within an object)
+* eql (checks equality with QUnit's equal)
+* beSimilarTo (checks equality with QUnit's deepEqual)
+* be (asserts true)
+* beA, beAn (checks type)
+* match (checks against a regular expression)
+* respondTo (checks that a function exists)
+
## What's it do?
I wrote some matchers and used QUnit's module and test methods, that's all. The test file is a great form of documentation and demonstrates everything SpecIt can do currently.

0 comments on commit 199ebcc

Please sign in to comment.