Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 100 lines (70 sloc) 4.182 kB
deee463 @logicalparadox documentation
logicalparadox authored
1 [![Build Status](https://secure.travis-ci.org/logicalparadox/chai.png)](http://travis-ci.org/logicalparadox/chai)
439ae02 @logicalparadox updated README
logicalparadox authored
2
4c2dd21 @logicalparadox readme image fixed [ci skip]
logicalparadox authored
3 [![Chai Documentation](https://github.com/logicalparadox/chai/raw/master/docs/template/assets/img/chai-logo.png)](http://chaijs.com)
439ae02 @logicalparadox updated README
logicalparadox authored
4
0cf619c @logicalparadox docs ready for upcoming 0.1.1
logicalparadox authored
5 Chai is a BDD / TDD assertion library for [node](http://nodejs.org) and the browser that
deee463 @logicalparadox documentation
logicalparadox authored
6 can be delightfully paired with any javascript testing framework.
7
8 For more information view the [documentation](http://chaijs.com).
439ae02 @logicalparadox updated README
logicalparadox authored
9
10 ## Installation
11
d9215b8 @logicalparadox docs and readme for upcoming 0.4.0
logicalparadox authored
12 Chai is available for both node.js and the browser using any
13 test framework you like.
439ae02 @logicalparadox updated README
logicalparadox authored
14
15 ### Node.js
16
17 Package is available through [npm](http://npmjs.org):
18
19 npm install chai
20
21 Recommend adding it to package.json devDependancies.
22
23 ### Browser
24
25 Include the chai browser build in your testing suite.
26
27 <script src="chai.js" type="text/javascript"></script>
28
d9215b8 @logicalparadox docs and readme for upcoming 0.4.0
logicalparadox authored
29 Currently supports all modern browsers: IE 9+, Chrome 7+, FireFox 4+, Safari 5+. Want to know if your browser is compatible?
30 Run the [online test suite](http://chaijs.com/support/tests/).
5974944 @logicalparadox readme notice on browser compat
logicalparadox authored
31
502c09c @logicalparadox read me updates include plugins
logicalparadox authored
32 ## Plugins
33
b7d6010 @logicalparadox doc updates
logicalparadox authored
34 The Chai community is growing! Plugins allow developers to expand Chai's available
502c09c @logicalparadox read me updates include plugins
logicalparadox authored
35 assertions. Here is what the community has come up with so far:
36
37 * [chai-spies](https://github.com/logicalparadox/chai-spies) is a basic spy implementation for chai. It's also
38 a good resource for building chai plugins that work in both node.js and the browser.
39 * [chai-jquery](https://github.com/jfirebaugh/chai-jquery) by [@jfirebaugh](https://github.com/jfirebaugh)
40 provides deep jQuery integration with chai's `should` and `expect`.
41 * [jack](https://github.com/vesln/jack) by [@vesln](https://github.com/vesln) is a mock/stub library that
42 can be used as a stand-alone or with chai.
3b85070 @logicalparadox sinon-chai link
logicalparadox authored
43 * [sinon-chai](https://github.com/domenic/sinon-chai) by [@domenic](https://github.com/domenic) extends chai with
44 assertions for the Sinon.js mocking framework.
de82d4f @logicalparadox chai as promised - readme
logicalparadox authored
45 * [chai-as-promised](https://github.com/domenic/chai-as-promised) by [@domenic](https://github.com/domenic) extends
46 chai with assertions about promises.
502c09c @logicalparadox read me updates include plugins
logicalparadox authored
47
ffbce63 @logicalparadox read me update
logicalparadox authored
48 ## Getting Help
49
50 If you have questions or issues, please use this projects
51 [Github Issues](https://github.com/logicalparadox/chai/issues). You can also keep up to date
52 on the [Google Group](http://groups.google.com/group/chaijs) or ping [@jakeluer](http://twitter.com/jakeluer)
53 directly on Twitter. Chai developers can also be found on Freenode IRC in #letstest.js.
54
f5ca373 @logicalparadox version notes
logicalparadox authored
55 ## Versions
56
57 The current stable version tree is the `0.5.x` tree on the `master` branch. If you are interested in seeing
58 what we have planned, or if you are a plugin developer interested in preparing your plugins for the
59 next major release, see the `0.6.x` branch.
60
61 - Stable: 0.5.x
62 - Unstables: 0.6.x
63
502c09c @logicalparadox read me updates include plugins
logicalparadox authored
64 ## Contributors
65
ffbce63 @logicalparadox read me update
logicalparadox authored
66 commits: 252
d9215b8 @logicalparadox docs and readme for upcoming 0.4.0
logicalparadox authored
67 files : 71
502c09c @logicalparadox read me updates include plugins
logicalparadox authored
68 authors:
ffbce63 @logicalparadox read me update
logicalparadox authored
69 192 Jake Luer 76.2%
70 53 Veselin Todorov 21.0%
71 3 Jeff Barczewski 1.2%
72 1 Vinay Pulim 0.4%
73 1 Jo Liss 0.4%
74 1 Domenic Denicola 0.4%
75 1 John Firebaugh 0.4%
439ae02 @logicalparadox updated README
logicalparadox authored
76
77 ## License
78
79 (The MIT License)
80
b7d6010 @logicalparadox doc updates
logicalparadox authored
81 Copyright (c) 2011-2012 Jake Luer <jake@alogicalparadox.com>
439ae02 @logicalparadox updated README
logicalparadox authored
82
83 Permission is hereby granted, free of charge, to any person obtaining a copy
84 of this software and associated documentation files (the "Software"), to deal
85 in the Software without restriction, including without limitation the rights
86 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
87 copies of the Software, and to permit persons to whom the Software is
88 furnished to do so, subject to the following conditions:
89
90 The above copyright notice and this permission notice shall be included in
91 all copies or substantial portions of the Software.
92
93 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
94 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
95 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
96 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
97 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
98 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
5974944 @logicalparadox readme notice on browser compat
logicalparadox authored
99 THE SOFTWARE.
Something went wrong with that request. Please try again.