Skip to content

Commit c15707e

Browse files
committed
docs: update readme
1 parent a25993f commit c15707e

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
4343
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
4444

45+
4546
- [The problem](#the-problem)
4647
- [The solution](#the-solution)
4748
- [When to use this library](#when-to-use-this-library)
@@ -141,17 +142,21 @@ npm install --save-dev @testing-library/react-hooks
141142
### Peer Dependencies
142143

143144
`react-hooks-testing-library` does not come bundled with a version of
144-
[`react`](https://www.npmjs.com/package/react) or
145-
[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
146-
the specific version you want to test against. Generally, the installed versions for `react` and
147-
`react-test-renderer` should have matching versions:
145+
[`react`](https://www.npmjs.com/package/react) to allow you to install the specific version you want
146+
to test against. It also does not come installed with a specific renderer, we currently support
147+
[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) and
148+
[`react-dom`](https://www.npmjs.com/package/react-dom), you only need to install one of them.
149+
However,you can install both, but `react-test-renderer` is the default, for more information see the
150+
[installation docs](https://react-hooks-testing-library.com/#installation). Generally, the installed
151+
versions for `react` and the selected renderer should have matching versions:
148152

149153
```sh
150154
npm install react@^16.9.0
151155
npm install --save-dev react-test-renderer@^16.9.0
152156
```
153157

154-
> **NOTE: The minimum supported version of `react` and `react-test-renderer` is `^16.9.0`.**
158+
> **NOTE: The minimum supported version of `react`, `react-test-renderer` and `react-dom` is
159+
> `^16.9.0`.**
155160
156161
## API
157162

0 commit comments

Comments
 (0)