Update README.md

Author: NielsJPeschel

hooks/useRetry/README.md

@@ -3,20 +3,54 @@
 A React hook that simplifies retrying failed service calls.
 
 ## Usage
-`useRetry` is designed to be used in tandem with [useLoadData](../useLoadData/). This hook will trigger `retry` from errored [retry response objects](../../types/RetryResponse.ts), and only those responses. 
+`useRetry` exposes a wrapped version of [useLoadData](../useLoadData/) that retries any and all errored [retry response objects](../../types/RetryResponse), and only those responses created, from that exposed version of _useLoadData_. 
+
 
 
 ```Typescript
 import React from 'react';
-import {useLoadData, useRetry} from 'react-hooks';
+import {useRetry} from '@optum/react-hooks';
 
+export const MyComponent = (props) => {
+ const {useLoadData, retry} = useRetry();
+ const loadedContent = useLoadData(fetchContent);
+ const loadedUserProfile = useLoadData(fetchUserProfile);
+ const loadedResults = useLoadData(fetchResults);
+ if(
+    loadedContent.isInProgress ||
+    loadedUserProfile.isInProgress ||
+    loadedResults.IsInProgress
+ ) {
+    return <div>Loading your page</div>
+ } else if(
+    loadedContent.isError ||
+    loadedUserProfile.isError ||
+    loadedResults.isError
+) {
+        return <button onClick={retry}>Retry</button>
+    }
+    else {
+        return ...
+    }
+}
+```
+
+In addition, a list of any `useLoadData` responses can be passed as arguments (not just responses returned by the wrapped version of `useLoadData`) and when the `retry` function is called, any failed responses will be retried.
+
+```Typescript
+import React from 'react';
+import {useLoadData, useRetry} from '@optum/react-hooks';
 
 export const MyComponent = (props) => {
  const loadedContent = useLoadData(fetchContent);
  const loadedUserProfile = useLoadData(fetchUserProfile);
  const loadedResults = useLoadData(fetchResults);
 
- const retry = useRetry(loadedContent, loadedUserProfile, loadedResults);
+ const {retry} = useRetry(
+    loadedContent,
+    loadedUserProfile,
+    loadedResults
+ );
 
  if(
     loadedContent.isInProgress ||
@@ -37,6 +71,7 @@ export const MyComponent = (props) => {
 }
 ```
 
+
 ## API
 
 `useRetry` takes the following arguments:
@@ -46,4 +81,12 @@ export const MyComponent = (props) => {
 | `...apis` | `RetryResponse[]` | any number of retry responses returned from instances of `useLoadData` |
 
 
-The return value of `useRetry` is a function `() => void` that triggers the **retry** property of errored RetryResponses.
+The return value from `useLoadData` contains the following properties:
+
+| Name           | Type                   | Description                                                                                                                                                  |
+| -------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `useLoadData` | `typeof useLoadData`              | Modified version of [useLoadData]('../useLoadData').                                                                             |
+| `retry`      | `() => void`              | Retries any retry response created by the _useLoadData_ exposed with this hook in addition to retrying errored retry responses passsed into this hook.                                                  |
+| `isMaxRetry`        | `boolean` | True if any retry response either passed or created via the useLoadData exposed in this hook has reached it's _isMaxRetry_                                                                              |
+
+