From 4d814e8dc57a9f41de492822fcff9876f892985a Mon Sep 17 00:00:00 2001
From: karmaniverous <me@karmanivero.us>
Date: Tue, 20 Dec 2022 21:34:46 +0800
Subject: [PATCH] docs update

---
 README.md     | 9 +++++++--
 doc/1-main.md | 9 +++++++--
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index af84cf8..f3f24b8 100644
--- 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
index 101f7b7..805a60b 100644
--- 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!