From 804b91af678a48ea43461d951a6ccb628f5cb387 Mon Sep 17 00:00:00 2001 From: Marcel Tinner Date: Fri, 26 Apr 2019 07:23:28 +0200 Subject: [PATCH] update docs with peerDependency information --- .all-contributorsrc | 9 +++++++++ README.md | 8 +++++++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 26995810..bcece3d4 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -92,6 +92,15 @@ "contributions": [ "doc" ] + }, + { + "login": "mtinner", + "name": "Marcel Tinner", + "avatar_url": "https://avatars0.githubusercontent.com/u/5487448?v=4", + "profile": "https://github.com/mtinner", + "contributions": [ + "doc" + ] } ], "commitConvention": "none" diff --git a/README.md b/README.md index bdbba68f..94ec63f1 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,12 @@ test('should decrement counter', () => { npm install --save-dev react-hooks-testing-library ``` +We are using [react-test-renderer](https://www.npmjs.com/package/react-test-renderer) as a peerDependency, so make sure you have installed this library as well. Install the same version like you use in react. +```sh +npm install --save-dev react-test-renderer@x.y.z +``` + + ## API ### `renderHook(callback[, options])` @@ -137,10 +143,10 @@ This is the same [`act` function](https://reactjs.org/docs/hooks-faq.html#how-to ## Contributors Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): +
Michael Peyper
Michael Peyper

💻 🎨 📖 🤔 🚇 📦 ⚠️ 🔧
otofu-square
otofu-square

💻
Patrick P. Henley
Patrick P. Henley

🤔 👀
Matheus Marques
Matheus Marques

💻
Dhruv Patel
Dhruv Patel

🐛 👀
Nathaniel Tucker
Nathaniel Tucker

🐛 👀
Sergei Grishchenko
Sergei Grishchenko

💻 📖 🤔
Josep M Sobrepere
Josep M Sobrepere

📖
Marcel Tinner
Marcel Tinner

📖
-
Michael Peyper
Michael Peyper

💻 🎨 📖 🤔 🚇 📦 ⚠️ 🔧
otofu-square
otofu-square

💻
Patrick P. Henley
Patrick P. Henley

🤔 👀
Matheus Marques
Matheus Marques

💻
Dhruv Patel
Dhruv Patel

🐛 👀
Nathaniel Tucker
Nathaniel Tucker

🐛 👀
Sergei Grishchenko
Sergei Grishchenko

💻 📖 🤔
Josep M Sobrepere
Josep M Sobrepere

📖