Add nice README

ammario · ammario · commit 3eddb06f6581 · 2018-02-22T19:44:19.000-06:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Coder Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,55 @@
+# retry
+
+An expressive, flexible retry package for Go.
+
+[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/codercom/retry)
+
+## Features
+
+- Exponential backoff
+- Jitter
+- Bound to context
+- Bound to timeout
+- Bound to attempt count
+- Bound to certain kinds of errors
+- Any combination of the above
+- Retrying net.Listener wrapper 
+
+## Examples
+
+This code will succeed after about a second.
+
+```go
+start := time.Now()
+
+err := retry.New(time.Millisecond).
+    Backoff(time.Millisecond * 50).
+    Timeout(time.Second * 2).
+    Run(
+        func() error {
+            if time.Since(start) < time.Second {
+                return errors.New("not enough time has elapsed")
+            }
+            return nil
+        },
+    )
+fmt.Printf("err: %v, took %v\n", err, time.Since(start))
+```
+
+---
+
+This code will block forever, since no `Timeout` or `Context` option
+was provided.
+
+```go
+start := time.Now()
+
+err := retry.New(time.Millisecond).
+    Backoff(time.Millisecond * 50).
+    Run(
+        func() error {
+            return errors.New("not enough time has elapsed")
+        },
+    )
+fmt.Printf("err: %v, took %v\n", err, time.Since(start))
+```
diff --git a/examples/backoff/main.go b/examples/backoff/main.go
@@ -0,0 +1,26 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+	"time"
+
+	"github.com/codercom/retry"
+)
+
+func main() {
+	start := time.Now()
+
+	err := retry.New(time.Millisecond).
+		Backoff(time.Millisecond * 50).
+		Timeout(time.Second * 2).
+		Run(
+			func() error {
+				if time.Since(start) < time.Second {
+					return errors.New("not enough time has elapsed")
+				}
+				return nil
+			},
+		)
+	fmt.Printf("err: %v, took %v\n", err, time.Since(start))
+}
diff --git a/listener_test.go b/listener_test.go
@@ -97,7 +97,7 @@ func TestListener(t *testing.T) {
 			case 3:
 				return nil, nil
 			default:
-				t.Fatal("test listener called too many times; callCount: %v", callCount)
+				t.Fatalf("test listener called too many times; callCount: %v", callCount)
 				panic("unreachable")
 			}
 		}

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ func TestListener(t *testing.T) {`
`97`	`97`	`case 3:`
`98`	`98`	`return nil, nil`
`99`	`99`	`default:`
`100`		`- t.Fatal("test listener called too many times; callCount: %v", callCount)`
	`100`	`+ t.Fatalf("test listener called too many times; callCount: %v", callCount)`
`101`	`101`	`panic("unreachable")`
`102`	`102`	`}`
`103`	`103`	`}`