You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

83 lines
4.5 KiB

4 years ago
  1. [![Chai Documentation](http://chaijs.com/public/img/chai-logo.png)](http://chaijs.com)
  2. [![license:mit](https://img.shields.io/badge/license-mit-green.svg?style=flat-square)](#license)<br>
  3. [![tag:?](https://img.shields.io/github/tag/chaijs/chai.svg?style=flat-square)](https://github.com/chaijs/chai/releases)
  4. [![build:?](https://img.shields.io/travis/chaijs/chai/master.svg?style=flat-square)](https://travis-ci.org/chaijs/chai)
  5. [![coverage:?](https://img.shields.io/coveralls/chaijs/chai/master.svg?style=flat-square)](https://coveralls.io/r/chaijs/chai)<br>
  6. [![npm:](https://img.shields.io/npm/v/chai.svg?style=flat-square)](https://www.npmjs.com/packages/chai)
  7. [![dependencies:?](https://img.shields.io/npm/dm/chai.svg?style=flat-square)](https://www.npmjs.com/packages/chai)
  8. [![devDependencies:?](https://img.shields.io/david/chaijs/chai.svg?style=flat-square)](https://david-dm.org/chaijs/chai)
  9. [![Selenium Test Status](https://saucelabs.com/browser-matrix/chaijs.svg)](https://saucelabs.com/u/chaijs)
  10. [![Slack Status](https://chai-slack.herokuapp.com/badge.svg)]( https://chai-slack.herokuapp.com/)
  11. [![Join the chat at https://gitter.im/chaijs/chai](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/chaijs/chai)
  12. Chai is a BDD / TDD assertion library for [node](http://nodejs.org) and the browser that
  13. can be delightfully paired with any javascript testing framework.
  14. For more information or to download plugins, view the [documentation](http://chaijs.com).
  15. ### Plugins
  16. Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.
  17. - Need a plugin? View the [official plugin list](http://chaijs.com/plugins).
  18. - 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).
  19. - Want to build a plugin? Read the [plugin api documentation](http://chaijs.com/guide/plugins/).
  20. ### Related Projects
  21. - [chaijs / assertion-error](https://github.com/chaijs/assertion-error): Custom `Error` constructor thrown upon an assertion failing.
  22. - [chaijs / deep-eql](https://github.com/chaijs/deep-eql): Improved deep equality testing for Node.js and the browser.
  23. - [chaijs / type-detect](https://github.com/chaijs/type-detect): Improved typeof detection for node.js and the browser.
  24. ### Contributing
  25. Thank you very much for considering to contribute!
  26. Here are a few issues other contributors frequently ran into when opening pull requests:
  27. - Please do not commit changes to the `chai.js` build. We do it once per release.
  28. - Before pushing your commits, please make sure you [rebase](https://github.com/chaijs/chai/blob/master/CONTRIBUTING.md#pull-requests) them.
  29. We also strongly encourage you to read our detailed [contribution guidelines](https://github.com/chaijs/chai/blob/master/CONTRIBUTING.md).
  30. ### Contributors
  31. Please see the full
  32. [Contributors Graph](https://github.com/chaijs/chai/graphs/contributors) for our
  33. list of contributors.
  34. ### Core Contributors
  35. Feel free to reach out to any of the core contributors with your questions or
  36. concerns. We will do our best to respond in a timely manner.
  37. [![Jake Luer](https://avatars3.githubusercontent.com/u/58988?v=3&s=50)](https://github.com/logicalparadox)
  38. [![Veselin Todorov](https://avatars3.githubusercontent.com/u/330048?v=3&s=50)](https://github.com/vesln)
  39. [![Keith Cirkel](https://avatars3.githubusercontent.com/u/118266?v=3&s=50)](https://github.com/keithamus)
  40. ## License
  41. (The MIT License)
  42. Copyright (c) 2011-2015 Jake Luer <jake@alogicalparadox.com>
  43. Permission is hereby granted, free of charge, to any person obtaining a copy
  44. of this software and associated documentation files (the "Software"), to deal
  45. in the Software without restriction, including without limitation the rights
  46. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  47. copies of the Software, and to permit persons to whom the Software is
  48. furnished to do so, subject to the following conditions:
  49. The above copyright notice and this permission notice shall be included in
  50. all copies or substantial portions of the Software.
  51. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  52. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  53. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  54. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  55. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  56. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  57. THE SOFTWARE.