docs update

karmaniverous · Dec 20, 2022 · 4d814e8 · 4d814e8
1 parent 4b6a49f
commit 4d814e8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,12 @@
 # block-refresh
 
-See [tests](/src/export/blockRefresh/blockRefresh.test.mjs) for examples of
-usage!
+Use as the equalityFn argument to Redux
+[useSelector](https://react-redux.js.org/api/hooks#useselector) when the
+selected value is an Object.
+
+See
+[tests](https://github.com/karmaniverous/block-refresh/blob/main/src/export/blockRefresh/blockRefresh.test.mjs)
+for examples of usage!
 
 # API Documentation
 

diff --git a/doc/1-main.md b/doc/1-main.md
@@ -1,4 +1,9 @@
 # block-refresh
 
-See [tests](/src/export/blockRefresh/blockRefresh.test.mjs) for examples of
-usage!
+Use as the equalityFn argument to Redux
+[useSelector](https://react-redux.js.org/api/hooks#useselector) when the
+selected value is an Object.
+
+See
+[tests](https://github.com/karmaniverous/block-refresh/blob/main/src/export/blockRefresh/blockRefresh.test.mjs)
+for examples of usage!