Skip to content

Commit

Permalink
Update readme with a link to readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
pineapplemachine committed Mar 27, 2018
1 parent ad0fcf7 commit 451357e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Canary is a tool for writing and running automated tests in JavaScript code. It was written with tests and implementation sharing the same file foremost in mind. When tests and implementation are close together, it's more difficult to forget or ignore tests when making changes to the implementation.

Check out Canary's documentation at [canary.readthedocs.io](http://canary.readthedocs.io/).

Canary lets you control where and how you write your tests, how they are run, and how their results are reported. In case you aren't worried about the specifics of your how your test runner functions and reports results, just as long as it works, Canary can also run tests and report results with one function call for sensible default behavior.

Canary works best when used in combination with an assertion library such as [chai](http://www.chaijs.com/) or node's [assert](https://nodejs.org/api/assert.html) module.
Expand Down

0 comments on commit 451357e

Please sign in to comment.