Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
agoldis committed Mar 9, 2023
1 parent 636f3bf commit 7c2b13e
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# Cypress Cloud: Debug, troubleshoot and record Cypress CI tests in Cloud
# Debug, troubleshoot and record Cypress CI tests in Cloud

Integrate Cypress with alternative cloud services like Currents or Sorry Cypress.

---
**[Currents](https://currents.dev/?utm_source=cypress-cloud)** - a drop-in replacement for Cypress Dashboard. Run, debug, troubleshoot and analyze parallel CI tests in cloud. This is an enhanced version of Sorry Cypress with better security, performance, analytics, integrations and support.

**[Currents.dev](https://currents.dev/?utm_source=cy2)** - is a hosted cloud service used to run millions of Cypress tests without breaking the bank. This is an enhanced version of Sorry Cypress with better security, performance, analytics, integrations and support.
**[Sorry Cypress](https://sorry-cypress.dev/?utm_source=cypress-cloud)** - is an open-source, free alternative to Cypress Dashboard that unlocks unlimited parallelization, test recordings, and integration with GitHub, Slack and more.

**[Sorry Cypress](https://sorry-cypress.dev/?utm_source=cy2)** - is an open-source, free alternative to Cypress Cloud that unlocks unlimited parallelization, test recordings, and integration with GitHub, Slack and more.
<p align="center">
<img width="830" src="https://user-images.githubusercontent.com/1637928/213367982-78987b7a-411a-4d2e-9486-ca204847022e.png" />
</p>

---
<p align="center">
<a href="./CHANGELOG.md">Changelog</a> | <a href="https://currents.dev/readme/guides/cypress-compatibility">Compatibility</a> |
<a href="https://currents.dev/readme">Documentation</a> | <a href="./LICENCE.md">License</a>

[Changelog](./CHANGELOG.md) | [License](./LICENSE)
</p>

## Requirements

The package requires cypress version 10+.
The package requires cypress version 10+ and NodeJS 14.7.0+

## Setup

Expand Down Expand Up @@ -55,11 +59,11 @@ module.exports = defineConfig({
npx cypress-cloud --parallel --record --key <your_key> --ci-build-id hello-cypress-cloud
```

See all the available options `npx cypress-cloud --help`
See all the available options `npx cypress-cloud --help`. Learn more about [CI Build Id](https://currents.dev/readme/guides/cypress-ci-build-id).

## Example

See an example in [examples/webapp](./example/webapp) directory
See an example in [examples/webapp](./example/webapp) directory.

## Configuration

Expand Down

0 comments on commit 7c2b13e

Please sign in to comment.