README for a gem

charlieanna · January 13, 2014, 5:04pm

I created a gem called Pushofy. But now I want create a nicely formatted README for it. How should I do it with proper formatting for text and code? Right now I am not sure how the formatting was done. Some part of the code got formatted while some did not.

r00k · January 13, 2014, 6:50pm

Assuming you’re referring to how the README looks on GitHub, this is likely what you’re missing: Writing on GitHub - GitHub Docs

charlieanna · January 14, 2014, 10:22am

Yeah that one. Thanks

Topic		Replies	Views
What do you think about my first gem? Ruby on Rails	0	477	September 24, 2013
My first gem -- anyone willing to give feedback? Ruby on Rails	3	805	July 7, 2016
Good Ruby open source project to study Ruby on Rails	4	762	May 16, 2013
Need suggestions for getting feedback on a new gem prototype Ruby on Rails	0	575	December 14, 2016
The (GitHub) Scientist Gem Ruby on Rails	0	1138	February 5, 2016

README for a gem

Related Topics