Skip to content
Create a gist now

Instantly share code, notes, and snippets. template


At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Code Example

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.


A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.


Provide code examples and explanations of how to get the project.

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.


Describe and show how to run the tests with code examples.


Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.


A short snippet describing the license (MIT, Apache, etc.)

Unknown commented Dec 7, 2013

Thank you :)

aloisdg commented Feb 19, 2014

Thanks !


Thank you! (...If I remember, you will not receive a notification for this)


Thank you!


Thanks very much for a great template!


Great template, thank you very much!

Plimsky commented Jul 3, 2015

Nice ! Thanks :-D

RayFoss commented Jul 7, 2015

Would be nice to have some more basic markdown in it.

ccywch commented Sep 16, 2015

Thanks a lot!

mitbal commented Nov 27, 2015

This is helpful. Thank you


This is an excellent guide. Thank you.

colkito commented Jan 12, 2016

great! thanks!


Awesome, thanks!

KevDoy commented Jan 17, 2016

This is great. Thank you!

Herm71 commented Jan 21, 2016

Nice template, thanks!

Laicure commented Jan 25, 2016

Thanks! Nice template! <3




Thanks a lot <3


Really useful! Tks!


Thanks !

cAtilre commented Apr 19, 2016

This is great, thanks.


Nice job!


Really nice.


Thanks very much.




Thanks, exactly what I was looking for!

S1v4 commented May 14, 2016

Thank you!


How should i add a screenshot of my code , so that it gives an example how my code works ?


o ya ya



abjzb70 commented May 22, 2016


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.