Generate Readme

Author: Craig Pastro

README.md

@@ -18,25 +18,27 @@ slightly inspired by
 http get with retry:
 
     url := "http://example.com"
-    var body []byte
 
-    err := retry.Do(
-    	func() error {
+    body, err := retry.DoWithData(
+    	func() ([]byte, error) {
     		resp, err := http.Get(url)
     		if err != nil {
-    			return err
+    			return nil, err
     		}
     		defer resp.Body.Close()
-    		body, err = ioutil.ReadAll(resp.Body)
+    		body, err := ioutil.ReadAll(resp.Body)
     		if err != nil {
-    			return err
+    			return nil, err
     		}
 
-    		return nil
+    		return body, nil
     	},
     )
+    if err != nil {
+    	// handle error
+    }
 
-    fmt.Println(body)
+    fmt.Println(string(body))
 
 [next examples](https://github.com/avast/retry-go/tree/master/examples)
 
@@ -94,6 +96,12 @@ BackOffDelay is a DelayType which increases delay between consecutive retries
 func Do(retryableFunc RetryableFunc, opts ...Option) error
 ```
 
+#### func  DoWithData
+
+```go
+func DoWithData[T any](retryableFunc RetryableFuncWithData[T], opts ...Option) (T, error)
+```
+
 #### func  FixedDelay
 
 ```go
@@ -385,6 +393,14 @@ type RetryableFunc func() error
 
 Function signature of retryable function
 
+#### type RetryableFuncWithData
+
+```go
+type RetryableFuncWithData[T any] func() (T, error)
+```
+
+Function signature of retryable function with data
+
 #### type Timer
 
 ```go

retry.go

@@ -74,6 +74,7 @@ import (
 // Function signature of retryable function
 type RetryableFunc func() error
 
+// Function signature of retryable function with data
 type RetryableFuncWithData[T any] func() (T, error)
 
 // Default timer is a wrapper around time.After