docs: update readme to follow conventional style #22
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.