safwank / ElixirRetry

Simple Elixir macros for linear retry, exponential backoff and wait with composable delays
Other
441 stars 32 forks source link

chore: fix links in docs and add readme so hex.pm can parse it #57

Closed pdgonzalez872 closed 1 year ago

pdgonzalez872 commented 1 year ago

Hi! Thanks for the library!

I was pairing with a friend and we were looking at the docs for this lib. This PR adds the readme and also fixes the broken link (since you use master rather than main which is the default for ExDoc.

I saw a larger PR (https://github.com/safwank/ElixirRetry/pull/39) that seems to be stale at the moment, so I figured I'd create a smaller diff to get these changes in. Hope this helps!

Thank you so much for your work! Hope this helps.

Before

Broken link: image

Sidebar: image

After

Broken link: image

Sidebar: image