Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme to follow conventional style #22

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

seanpianka
Copy link
Contributor

@seanpianka seanpianka commented Feb 7, 2024

Hello again, long time no see 馃憢

I came back to check out the repository and thought that the README could use with a makeover. This new design follows a more conventional style that you'll find in many other popular repositories, and I think it'd boost the readability and user-friendliness of the docs for new users.

You can review the README here: https://github.com/seanpianka/google_maps/blob/master/README.md

You can see examples in this style here:

Let me know your thoughts and feel free to make any edits you find necessary.

You'll also want to include an MSRV value if you're aware of one.

Signed-off-by: Sean Pianka <pianka@eml.cc>
@leontoeides leontoeides merged commit be6125e into leontoeides:master Feb 8, 2024
@leontoeides
Copy link
Owner

Thank you very much for the README makeover, Sean. It looks much better

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.

None yet

2 participants