Skip to content

Commit 668adbb

Browse files
committed
Added warning about not using hooks in production
1 parent bbbe38d commit 668adbb

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# react-hooks-testing-library
22

3-
Simple component wrapper for testing React hooks.
3+
Simple component wrapper and utilities for testing React hooks.
4+
5+
> _**NOTE**: Hooks are a proposal in the current alpha version of React and are **NOT** recommended to use in production code. This library should be treated as a proof-of-concept **ONLY**._
6+
>
7+
> _Please refer to the [hook FAQ](https://reactjs.org/docs/hooks-faq.html) for more details on React hooks, their release timeframe and adoption strategy._
48
59
---
610

@@ -27,7 +31,7 @@ You don't really want to write a component solely for testing this hook and have
2731

2832
## The solution
2933

30-
The `react-hooks-testing-library` is build on top of the wonderful `react-testing-library` to create a simple test harness for React hooks that handles running them within the body of a function component, as well as privings various useful utility functions for updating the inputs and retrieving the outputs of your amazing custom hook.
34+
The `react-hooks-testing-library` is build on top of the wonderful [`react-testing-library`](http://npm.im/react-testing-library) to create a simple test harness for React hooks that handles running them within the body of a function component, as well as privings various useful utility functions for updating the inputs and retrieving the outputs of your amazing custom hook.
3135

3236
Using this library, you do not have to concern yourself with how the to interact construct, render or interact with the react component in order to test your hook. You can just use the hook directly and assert the resulting values.
3337

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-hooks-testing-library",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "Simple component wrapper for testing React hooks",
55
"main": "lib/index.js",
66
"author": "Michael Peyper",

0 commit comments

Comments
 (0)