Create README.md

Author: rentziass

README.md

@@ -0,0 +1,20 @@
+# eventually
+
+```go
+// Must will keep trying until it succeeds or the test times out or reaches
+// max attempts. If it fails, it will call t.Fatalf.
+eventually.Must(t, func(t testing.TB) {
+	t.Fatal("but keep trying")
+}, eventually.WithMaxAttempts(10))
+
+// Should will keep trying until it succeeds or the test times out or reaches
+// max attempts. If it fails, it will call t.Errorf.
+eventually.Should(t, func(t testing.TB) {
+	t.Fatal("but keep trying")
+}, eventually.WithTimeout(10*time.Second), eventually.WithInterval(1*time.Second))
+```
+
+## TODO
+- [ ] Support `Cleanup`
+- [ ] Support `Skip`?
+- [ ] Add documentation