Files
cypress/README.md
T
2018-01-29 21:51:01 -05:00

72 lines
2.5 KiB
Markdown

<p align="center">
<img src="https://cloud.githubusercontent.com/assets/1268976/20607953/d7ae489c-b24a-11e6-9cc4-91c6c74c5e88.png"/>
</p>
<p align="center">
<a href="https://on.cypress.io">Documentation</a> |
<a href="https://on.cypress.io/changelog">Changelog</a> |
<a href="https://on.cypress.io/roadmap">Roadmap</a>
</p>
<h3 align="center">
The web has evolved. Finally, testing has too.
</h3>
<p align="center">
Fast, easy and reliable testing for anything that runs in a browser.
</p>
<p align="center">
<a href="https://www.npmjs.com/package/cypress">
<img src="https://img.shields.io/npm/dm/cypress.svg" alt="npm"/>
</a>
<a href="https://gitter.im/cypress-io/cypress">
<img src="https://img.shields.io/gitter/room/cypress-io/cypress.svg" alt="Gitter chat"/>
</a><br />
<a href="https://opencollective.com/cypressio">
<object type="image/svg+xml" data="https://opencollective.com/cypressio/tiers/corporate-backer.svg?avatarHeight=64&width=600" />
</a>
</p>
## What is Cypress?
<p align="center">
<a href="https://player.vimeo.com/video/237527670">
<img alt="Why Cypress Video" src="https://user-images.githubusercontent.com/1271364/31739717-dbdff0ee-b41c-11e7-9b16-bfa1b6ac1814.png" width="75%" height="75%" />
</a>
</p>
## Installing
[![npm version](https://badge.fury.io/js/cypress.svg)](https://badge.fury.io/js/cypress)
Install Cypress for Mac, Linux, or Windows, then [get started](https://docs.cypress.io/guides/getting-started/installing-cypress.html).
```bash
npm install cypress --save-dev
```
![installing-cli e1693232](https://user-images.githubusercontent.com/1271364/31740846-7bf607f0-b420-11e7-855f-41c996040d31.gif)
## Contributing
[![CircleCI](https://circleci.com/gh/cypress-io/cypress/tree/master.svg?style=svg)](https://circleci.com/gh/cypress-io/cypress/tree/master) - `master` branch
Please see our [Contributing Guideline](/CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps.
## License
[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cypress-io/cypress/blob/master/LICENSE.md)
This project is licensed under the terms of the [MIT license](/LICENSE.md).
## Badges
Let the world know your project is using Cypress.io to test with this cool badge
[![badge](https://img.shields.io/badge/cypress.io-tests-green.svg?style=flat-square)](https://cypress.io)
```
[![Cypress.io tests](https://img.shields.io/badge/cypress.io-tests-green.svg?style=flat-square)](https://cypress.io)
```