added comments

danvixent · Feb 20, 2015 · 9162e81 · 9162e81
1 parent 62b916f
commit 9162e81
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@ Idiomatic Go retry package
 
 ## Usage
 
+Just call `try.Do` with the function you want to retry in the event of an error:
+
 ```
 var value string
 err := try.Do(func(attempt int) (error, bool) {
@@ -32,6 +34,8 @@ To see if a `Do` operation failed due to reaching the limit, you can check the `
 
 #### Retrying panics
 
+Try supports retrying in the event of a panic.
+
   * Use named return parameters
   * Set `retry` first
   * Defer the recovery code, and set `err` manually in the case of a panic