Skip to content
This repository was archived by the owner on Mar 5, 2022. It is now read-only.

Commit ad89d98

Browse files
Josh Justicebahmutov
Josh Justice
authored andcommitted
Readme consistency with cypress-vue-unit-test (#7)
* General intro content * Enzyme comparison
1 parent 8b97e63 commit ad89d98

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
11
# cypress-react-unit-test [![Build Status](https://travis-ci.org/bahmutov/cypress-react-unit-test.svg?branch=master)](https://travis-ci.org/bahmutov/cypress-react-unit-test) [![Cypress.io tests](https://img.shields.io/badge/cypress.io-tests-green.svg?style=flat-square)](https://dashboard.cypress.io/#/projects/z9dxah)
22

3-
> Unit test React components using Cypress **ALPHA**
3+
> A little helper to unit test Vue components in the open source [Cypress.io](https://www.cypress.io/) E2E test runner **ALPHA**
4+
5+
## TLDR
6+
7+
* What is this? This package allows you to use [Cypress](https://www.cypress.io/) test runner to unit test your React components with zero effort.
8+
9+
* How is this different from [Enzyme](https://github.com/airbnb/enzyme)? It is similar in functionality BUT runs the component in the real browser with full power of Cypress E2E test runner: [live GUI, full API, screen recording, CI support, cross-platform](https://www.cypress.io/features/).
410

511
## Known problems
612

713
- [ ] some DOM events are not working when running all tests at once [#4](https://github.com/bahmutov/cypress-react-unit-test/issues/4)
814
- [ ] cannot mock server XHR for injected components [#5](https://github.com/bahmutov/cypress-react-unit-test/issues/5)
915
- [ ] cannot spy on `window.alert` [#6](https://github.com/bahmutov/cypress-react-unit-test/issues/6)
1016

17+
## Install
18+
19+
Requires [Node](https://nodejs.org/en/) version 6 or above.
20+
21+
```sh
22+
npm install --save-dev cypress cypress-react-unit-test
23+
```
24+
1125
## Use
1226

1327
```js

0 commit comments

Comments
 (0)