Add readme for debug and bump version to 1.4.0

mblink · Dec 30, 2021 · 40dd54d · 40dd54d
1 parent 50ff206
commit 40dd54d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -59,6 +59,14 @@ useStableEffect(() => {
 }, [data], Eq.getTupleEq(O.getEq(Eq.eqString)));
 ```
 
+## Debugging Your Hooks
+
+You can console log the reasons behind why certain hooks are called again by passing a debug flag to each one of the
+stable hooks which have equality functions provided in the API. The last parameter of the function is now a config
+object: `StableHookOptions`.
+
+You can pass `{debug: true}` to have the console logs printed in all environments except for `production`.
+
 ## API
 
 | React&nbsp;Hook | Stable&nbsp;Hook      | Description |

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "fp-ts-react-stable-hooks",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Stable hooks for react using FP-TS equality checks instead of shallow (reference) object comparison",
   "main": "dist/lib/index.js",
   "module": "dist/es2015/index.js",