Skip to content

Commit 08571a6

Browse files
authored
docs(readme): Install and requirements section (#9)
1 parent d29f273 commit 08571a6

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,24 @@ React Native solves this problem through [Jest](https://jestjs.io/). They provid
2020

2121
This library aims to solve this problem. It provides mocks just as React Native does, but in much faster/simpler way and without the need of Jest. It also transforms the React Native Flow code on the fly, and solves the haste map modules so don't have to worry about that either. Transforming on the fly takes a few seconds the first time, but then it get's cached and it gets 6x faster. Overall, this library makes it possible to test React Native in other frameworks, like [Mocha.js](https://mochajs.org/), etc.
2222

23+
## Requirements
24+
25+
- **Node.js:** >=18
26+
- **react:** >=18.2.0
27+
- **react-native:** ">=0.73.2
28+
29+
## Install
30+
31+
With NPM:
32+
```
33+
npm i --save-dev react-native-testing-mocks
34+
```
35+
36+
With Yarn:
37+
```
38+
yarn add --dev react-native-testing-mocks
39+
```
40+
2341
## Usage
2442

2543
To register the testing mocks you just need to load the effect in a file that runs before all tests:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
},
7272
"peerDependencies": {
7373
"react": ">=18.2.0",
74-
"react-native": ">=0.73.1"
74+
"react-native": ">=0.73.2"
7575
},
7676
"peerDependenciesMeta": {
7777
"react": {

yarn.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8853,7 +8853,7 @@ __metadata:
88538853
typescript: "npm:^5.3.3"
88548854
peerDependencies:
88558855
react: ">=18.2.0"
8856-
react-native: ">=0.73.1"
8856+
react-native: ">=0.73.2"
88578857
peerDependenciesMeta:
88588858
react:
88598859
optional: false

0 commit comments

Comments
 (0)