chai/README.md

138 lines
5.8 KiB
Markdown
Raw Normal View History

2012-05-15 18:30:19 +00:00
[![Chai Documentation](http://chaijs.com/public/img/chai-logo.png)](http://chaijs.com)
2011-12-15 12:50:06 +00:00
2015-03-15 22:03:18 +00:00
[![license:mit](https://img.shields.io/badge/license-mit-green.svg?style=flat-square)](#license)<br>
[![tag:?](https://img.shields.io/github/tag/chaijs/chai.svg?style=flat-square)](https://github.com/chaijs/chai/releases)
[![build:?](https://img.shields.io/travis/chaijs/chai/master.svg?style=flat-square)](https://travis-ci.org/chaijs/chai)
[![coverage:?](https://img.shields.io/coveralls/chaijs/chai/master.svg?style=flat-square)](https://coveralls.io/r/chaijs/chai)<br>
[![npm:](https://img.shields.io/npm/v/chai.svg?style=flat-square)](https://www.npmjs.com/packages/chai)
[![dependencies:?](https://img.shields.io/npm/dm/chai.svg?style=flat-square)](https://www.npmjs.com/packages/chai)
[![devDependencies:?](https://img.shields.io/david/chaijs/chai.svg?style=flat-square)](https://david-dm.org/chaijs/chai)
[![Selenium Test Status](https://saucelabs.com/browser-matrix/chaijs.svg)](https://saucelabs.com/u/chaijs)
2011-12-16 11:57:51 +00:00
Chai is a BDD / TDD assertion library for [node](http://nodejs.org) and the browser that
2011-12-16 11:15:30 +00:00
can be delightfully paired with any javascript testing framework.
2012-05-15 18:27:49 +00:00
For more information or to download plugins, view the [documentation](http://chaijs.com).
2012-05-09 18:45:45 +00:00
2014-03-19 16:22:08 +00:00
### Plugins
Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.
- Need a plugin? View the [official plugin list](http://chaijs.com/plugins).
2015-02-01 03:33:52 +00:00
- Have a plugin and want it listed? Open a Pull Request at [chaijs/chai-docs:plugin.js](https://github.com/chaijs/chai-docs/blob/master/plugins.js#L1-L12).
2014-03-19 16:22:08 +00:00
- Want to build a plugin? Read the [plugin api documentation](http://chaijs.com/guide/plugins/).
2013-06-17 20:06:38 +00:00
### Related Projects
2013-09-18 19:04:00 +00:00
- [chaijs / assertion-error](https://github.com/chaijs/assertion-error): Custom `Error` constructor thrown upon an assertion failing.
2014-01-26 06:35:09 +00:00
- [chaijs / deep-eql](https://github.com/chaijs/deep-eql): Improved deep equality testing for Node.js and the browser.
2013-06-17 20:06:38 +00:00
2012-05-09 18:45:45 +00:00
### Contributors
2012-02-13 19:03:34 +00:00
2015-02-09 18:43:58 +00:00
project : chai
2015-04-26 16:13:17 +00:00
repo age : 3 years, 5 months
active : 244 days
commits : 900
2015-02-09 18:43:58 +00:00
files : 59
2014-01-29 23:38:57 +00:00
authors :
2015-04-26 16:13:17 +00:00
555 Jake Luer 61.7%
79 Veselin Todorov 8.8%
52 Keith Cirkel 5.8%
43 Domenic Denicola 4.8%
2015-02-23 21:03:27 +00:00
14 Joshua Perry 1.6%
2015-02-09 18:43:58 +00:00
8 Chris Polis 0.9%
6 Ruben Verborgh 0.7%
2015-03-04 21:20:35 +00:00
6 Ian Zamojc 0.7%
2015-03-15 21:22:54 +00:00
5 George Kats 0.6%
2015-04-26 16:13:17 +00:00
5 leider 0.6%
2015-03-04 21:20:35 +00:00
5 Scott Nonnenberg 0.6%
5 Juliusz Gonera 0.6%
2015-04-26 16:13:17 +00:00
5 Jo Liss 0.6%
4 Jérémie Astori 0.4%
4 John Firebaugh 0.4%
4 charlierudolph 0.4%
4 Veselin 0.4%
4 Chris Jones 0.4%
4 Nick Heiner 0.4%
4 Max Edmands 0.4%
4 David da Silva 0.4%
4 Kaito Udagawa 0.4%
4 josher19 0.4%
3 Jordan Harband 0.3%
2015-02-23 21:03:27 +00:00
3 Ryunosuke SATO 0.3%
2015-04-26 16:13:17 +00:00
3 Jake Rosoman 0.3%
3 Duncan Beevers 0.3%
2015-03-15 21:22:54 +00:00
3 Jason Karns 0.3%
2015-03-04 21:20:35 +00:00
3 Jeff Barczewski 0.3%
2015-03-15 21:22:54 +00:00
3 Andrei Neculau 0.3%
2015-04-26 16:13:17 +00:00
2 eldritch fossicker 0.2%
2015-02-23 21:03:27 +00:00
2 Bartvds 0.2%
2015-03-04 21:20:35 +00:00
2 Edwin Shao 0.2%
2 Gregg Lind 0.2%
2015-03-15 21:22:54 +00:00
2 Jakub Nešetřil 0.2%
2015-04-26 16:13:17 +00:00
2 Roman Masek 0.2%
2 Teddy Cross 0.2%
2015-03-15 21:22:54 +00:00
1 Jesse McCarthy 0.1%
2015-04-26 16:13:17 +00:00
1 Doug Neiner 0.1%
1 Dido Arellano 0.1%
2015-02-09 18:43:58 +00:00
1 Kilian Ciuffolo 0.1%
1 Luís Cardoso 0.1%
1 Martin Middel 0.1%
1 Mathias Schreck 0.1%
2015-04-26 16:13:17 +00:00
1 Danilo Vaz 0.1%
2015-02-09 18:43:58 +00:00
1 Michael Lange 0.1%
2015-04-26 16:13:17 +00:00
1 Mitchell Johnson 0.1%
1 DD 0.1%
2015-02-09 18:43:58 +00:00
1 Niklas Närhinen 0.1%
1 Paul Miller 0.1%
1 Refael Ackermann 0.1%
2015-04-26 16:13:17 +00:00
1 shinnn 0.1%
1 Chun-Yi 0.1%
1 Christopher Hiller 0.1%
2015-02-09 18:43:58 +00:00
1 Sasha Koss 0.1%
2015-04-26 16:13:17 +00:00
1 Chris Thompson 0.1%
1 toastynerd 0.1%
1 Chris Connelly 0.1%
1 Chasen Le Hara 0.1%
2015-02-09 18:43:58 +00:00
1 Victor Costan 0.1%
1 Vinay Pulim 0.1%
1 Virginie BARDALES 0.1%
2015-03-04 21:20:35 +00:00
1 Vlad GURDIGA 0.1%
2015-04-26 16:13:17 +00:00
1 Brandon Payton 0.1%
1 Adam Hull 0.1%
2015-02-09 18:43:58 +00:00
1 ericdouglas 0.1%
2015-04-26 16:13:17 +00:00
1 Benjamin Horsleben 0.1%
2015-02-09 18:43:58 +00:00
1 laconbass 0.1%
2015-04-26 16:13:17 +00:00
1 Anand Patil 0.1%
2015-02-09 18:43:58 +00:00
1 mohayonao 0.1%
2015-03-15 21:22:54 +00:00
1 piecioshka 0.1%
1 root 0.1%
2015-04-26 16:13:17 +00:00
1 Julien Wajsberg 0.1%
1 Jeff Welch 0.1%
2011-12-15 12:50:06 +00:00
## License
(The MIT License)
2015-02-01 03:33:52 +00:00
Copyright (c) 2011-2015 Jake Luer <jake@alogicalparadox.com>
2011-12-15 12:50:06 +00:00
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2012-01-25 22:10:16 +00:00
THE SOFTWARE.