Update README file #57
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
rodolfobandeira
approved these changes
Oct 30, 2018
There was a problem hiding this comment.
Thanks for taking the initiative on this @maiaFernando
This is something I've been debating for a while, but never went deep doing a research to find a great way to write the Readme. I was just googling it here and found this repo that might be handy for us: https://github.com/matiassingers/awesome-readme
I'll separate some time this weekend to take a look on that and maybe take some action.
What are your thoughts on this @invacuo ?
For reference, there is now an issue so we could share some ideas:
rodolfobandeira
approved these changes
Oct 30, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
I noticed that the README file wasn't following any pattern for the writing. It seemed like the gem was made of little pieces of code joined together. In order to keep a default, I standardized some of the content of the README.md file. I still feel like there's more to do in this file, but I'm not sure what would be the best in these places (e.g.: in the examples for a specific object, should we keep a default of searching for an specific id, or looking for the first item? Or both?).