Skip to content

Commit

Permalink
Update readme with list of supported matchers
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuaclayton committed Jun 6, 2010
1 parent 3f8a672 commit 199ebcc
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.markdown
Expand Up @@ -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() {
Expand All @@ -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.
Expand Down

0 comments on commit 199ebcc

Please sign in to comment.