mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-03 05:20:38 -05:00
c2830a9d00
Added yarn support for cypress installation.
77 lines
2.6 KiB
Markdown
77 lines
2.6 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>
|
|
<a href="https://stackshare.io/cypress">
|
|
<img src="https://img.stackshare.io/misc/follow-on-stackshare-badge.svg" alt="StackShare"/>
|
|
</a><br />
|
|
</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
|
|
|
|
[](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
|
|
```
|
|
or
|
|
```bash
|
|
yarn add cypress --dev
|
|
```
|
|
|
|

|
|
|
|
|
|
## Contributing
|
|
|
|
- [](https://circleci.com/gh/cypress-io/cypress/tree/develop) - `develop` branch
|
|
- [](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
|
|
|
|
[](https://github.com/cypress-io/cypress/blob/master/LICENSE)
|
|
|
|
This project is licensed under the terms of the [MIT license](/LICENSE).
|
|
|
|
## Badges
|
|
|
|
Let the world know your project is using Cypress.io to test with this cool badge
|
|
|
|
[](https://www.cypress.io/)
|
|
|
|
```
|
|
[](https://www.cypress.io/)
|
|
```
|