Files
cypress/README.md
Jennifer Shehane 5adafb6c41 docs: Remove broken link from Readme (#28910)
* Remove broken link from Readme

* empty commit [skip ci]
2024-02-09 14:59:47 -05:00

95 lines
3.3 KiB
Markdown

<p align="center">
<a href="https://www.cypress.io">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/cypress-logo-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/cypress-logo-light.png">
<img alt="Cypress Logo" src="./assets/cypress-logo-light.png">
</picture>
</a>
</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">
Join us, we're <a href="https://cypress.io/jobs">hiring</a>.
</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://on.cypress.io/discord">
<img src="https://img.shields.io/badge/chat-on%20Discord-brightgreen" alt="Discord 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
[![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://on.cypress.io/install).
```bash
npm install cypress --save-dev
```
or
```bash
yarn add cypress --dev
```
or
```bash
pnpm add cypress --save-dev
```
![installing-cli e1693232](./assets/cypress-installation.gif)
## Contributing
[![cypress](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/ypt4pf/develop&style=flat&logo=cypress)](https://cloud.cypress.io/projects/ypt4pf/runs)
[![CircleCI](https://circleci.com/gh/cypress-io/cypress/tree/develop.svg?style=svg)](https://circleci.com/gh/cypress-io/cypress/tree/develop) - `develop` 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/develop/LICENSE)
This project is licensed under the terms of the [MIT license](/LICENSE).
## Badges
Configure a badge for your project's README to show your test status or test count in the [Cypress Cloud](https://www.cypress.io/cloud).
[![cypress](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/ypt4pf/develop&style=flat&logo=cypress)](https://cloud.cypress.io/projects/ypt4pf/runs)
[![cypress](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/count/ypt4pf/develop&style=flat&logo=cypress)](https://cloud.cypress.io/projects/ypt4pf/runs)
Or let the world know your project is using Cypress with the badge below.
[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)
```
[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)
```