docs(config): document debug attr (#74)

rubinovitz · web-flow · commit 2ce3cc3d5eff · 2021-03-11T14:45:58.000-05:00
diff --git a/README.md b/README.md
@@ -187,6 +187,16 @@ This hook returns the current database client with some helpful functions for sy
 
 Check out the [Firebase example](https://homebaseio.github.io/homebase-react/#!/example.todo_firebase) for a demonstration of how you might integrate a backend.
 
+##  Debugging tips
+
+If you set `debug` to `true` in your configuration, you will be able to access the `_recentlyTouchedAttributes` attribute on entities. `_recentlyTouchedAttributes` will show any cached attributes for a given entity. This is helpful for approximating that entity's schema and values.
+
+```js
+  <HomebaseProvider config={ debug: true }>
+    <App/>
+  </HomebaseProvider>
+```
+
 ## Roadmap
 
 1. Document integration with more backends
diff --git a/docs/0400|API.md b/docs/0400|API.md
@@ -18,6 +18,11 @@ const config = {
     }
   },
   
+  // Set `debug` to true in order to access the _recentlyTouchedAttributes attribute on your entities
+  //  _recentlyTouchedAttributes shows any cached attributes for a given entity
+  // This is helpful for approximating that entity's schema and values
+  debug: true,
+  
   // Initial data is what it sounds like.
   // It's a transaction that runs on component mount.
   // Use it to hydrate your app.
