Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2023
Merged

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

merged 1 commit into from
Apr 11, 2023

Conversation

pdgonzalez872
Copy link
Contributor

@pdgonzalez872 pdgonzalez872 commented Mar 17, 2023

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 (#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

@safwank safwank merged commit 45b3588 into safwank:master Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants