Skip to content

Instantly share code, notes, and snippets.

Created February 10, 2012 00:18
Show Gist options
  • Save jxson/1784669 to your computer and use it in GitHub Desktop.
Save jxson/1784669 to your computer and use it in GitHub Desktop. 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.)

Copy link

winex01 commented Jun 1, 2017

tnx. really appreciate it.

Copy link


Copy link


Copy link

Cool, that what I was looking for!

Copy link

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. 😊

Copy link

fodilo commented Jul 4, 2017

Thanks a lot

Copy link

Cool! ;)

Copy link

levone commented Jul 20, 2017

Thanks for this.

Copy link

Thank you

Copy link


Copy link

Thanks 👍

Copy link

Nice one. Thanks!

Copy link

rus89 commented Oct 3, 2017

Great. Thank you very much!

Copy link

This is very helpful.

Copy link

Thank you very much

Copy link

Thank you! :)

Copy link

Well done! thanks :)

Copy link


Copy link

Awesome! Thanks!

Copy link

Great one!!

Copy link

thanks 👍

Copy link

RCMiron commented Mar 4, 2018


Copy link


Copy link

Thanks a lot!

Copy link

Salamat po!

Copy link


Copy link

I still don't know how this?

Copy link

thank you!

Copy link

Thank you for sharing !

Copy link

Thanks for sharing

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