Wrong examples in the README

[MarcoVigna17]

I'm struggling to follow the examples in the README because I can't relate them to the package actual implementation:

1. breaker.BreakBySignal as long as the other breakers don't implement the strategy.Breaker interface (the Err() method is missing). This is also a problem in the implementation, that is backing me from using this breaker

2. The function (second parameter of retry.Do) must accept a context as parameter. This is not reflected in the documentation

[kamilsk]

Hi, @MarcoVigna17! Thanks for the report.

The function (second parameter of retry.Do) must accept a context as parameter. This is not reflected in the documentation

Yes, sorry for that, v5 is still unstable (the latest version is v5.0.0-rc5), and I didn't sync the readme. I fix that soon.

About the first point: I have an issue with an update of the interface, and it is partially implemented.

So, I can suggest using:

1. retry/v4 together with breaker any version
2. retry/v5-rc together with breaker/v1.2-rc

[kamilsk]

I added the Err() method to the breakers here.

[MarcoVigna17]

Thanks for the feedback @kamilsk.

I will try what you suggested today

[kamilsk]

@MarcoVigna17 I updated the readme and added information about breaker compatibility here
7a5261c

[kamilsk]

I close the issue but feel free to reopen it if needed.