Skip to content
Create a gist now

Instantly share code, notes, and snippets.

README.md template

Synopsis

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.

Motivation

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

Installation

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.

Tests

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

Contributors

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

License

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

@ghost
Unknown commented Dec 7, 2013

Thank you :)

@aloisdg
aloisdg commented Feb 19, 2014

Thanks !

@BrainCrumbz

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

@Sovietaced

Thank you!

@carlosloslas

Thanks very much for a great template!

@angajime

Great template, thank you very much!

@Plimsky
Plimsky commented Jul 3, 2015

Nice ! Thanks :-D

@RayFoss
RayFoss commented Jul 7, 2015

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

@ccywch
ccywch commented Sep 16, 2015

Thanks a lot!

@mitbal
mitbal commented Nov 27, 2015

This is helpful. Thank you

@gkbluestocking

This is an excellent guide. Thank you.

@colkito
colkito commented Jan 12, 2016

great! thanks!

@samkho10

Awesome, thanks!

@KevDoy
KevDoy commented Jan 17, 2016

This is great. Thank you!

@Herm71
Herm71 commented Jan 21, 2016

Nice template, thanks!

@Laicure
Laicure commented Jan 25, 2016

Thanks! Nice template! <3

@priyankinfinnov

nice

@rohit2389

Thanks a lot <3

@uilianries

Really useful! Tks!

@XiaoZYang

Thanks !

@cAtilre
cAtilre commented Apr 19, 2016

This is great, thanks.

@asikhalaban

Nice job!

@Karan-nassa

Really nice.

@AndrewDawes

Thanks very much.

@douglasdeodato

thanks

@IrfaanKamo

Thanks, exactly what I was looking for!

@S1v4
S1v4 commented May 14, 2016

Thank you!

@kapoor-rakshit

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

@romamaslennikov

o ya ya

@romamaslennikov

thanks

@abjzb70
abjzb70 commented May 22, 2016

thanks!!!

@alissaom

Thank you!

@boompah
boompah commented May 28, 2016

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

@shyamalmunshi

Thank you, this was very helpful!

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.