Create a gist now

Instantly share code, notes, and snippets.

What would you like to do? 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.)


ghost 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


Thank you!

boompah commented May 28, 2016

Thank you so much, going to start using this right now! :)

Thank you, this was very helpful!

What the beginner me really needed

thanks bro!

sfilhu commented Aug 20, 2016

Thank's for template man! But, if I to want write a code, what I do?

zarque commented Aug 20, 2016


Thanks for this template :) Much Appreciated

You have you write ``` at the start and end of that code and that'll do.


Thank you!


Kitanga commented Oct 20, 2016

Thank you!!

tkaghdo commented Oct 29, 2016

Thank you very much!

navneet1075 commented Nov 9, 2016

Thanks a lot . It really helped .

Great template, thank`s a lot!

ebanfa commented Nov 23, 2016

Great. Thanks

WeeHong commented Dec 12, 2016

Thank you for sharing. <3


Thank you


how his men dwonload

Thanks a bunch

Cool template. Thanks for sharing!

Odame commented Jan 19, 2017

Thanks for sharing

Nyakato commented Jan 24, 2017

Thanks alot

a13ks3y commented Jan 24, 2017

Thank you!

Colobri commented Feb 1, 2017


Thank you! Great guide :)

haimerb commented Feb 22, 2017

Thank you!

Thank you


Thank for the template

Woiyl commented Apr 13, 2017

Easy to integrate , thanks a lot !

oumarxy commented May 11, 2017

Thank you

azinio commented May 26, 2017

Arigato u Gozaimasu

winex01 commented Jun 1, 2017

tnx. really appreciate it.


Cool, that what I was looking for!

hinell commented Jun 30, 2017

I'm also excited to publish my own version of this readme.
It is more elaborate and have dynamic links for quick navigation. Check it out please. 😊

fodilo commented Jul 4, 2017

Thanks a lot

Cool! ;)

levone commented Jul 20, 2017

Thanks for this.

Thank you


Thanks 👍

Nice one. Thanks!

rus89 commented Oct 3, 2017

Great. Thank you very much!

This is very helpful.

Thank you very much

hlopes7 commented Dec 4, 2017

Thank you! :)

Well done! thanks :)


Awesome! Thanks!

max1m0u5 commented Jan 6, 2018

Great one!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment