Create a gist now

Instantly share code, notes, and snippets.

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

This comment has been minimized.

Show comment Hide comment
@ghost

ghost Dec 7, 2013

Thank you :)

ghost commented Dec 7, 2013

Thank you :)

@aloisdg

This comment has been minimized.

Show comment Hide comment
@aloisdg

aloisdg Feb 19, 2014

Thanks !

aloisdg commented Feb 19, 2014

Thanks !

@BrainCrumbz

This comment has been minimized.

Show comment Hide comment
@BrainCrumbz

BrainCrumbz May 6, 2014

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

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

@Sovietaced

This comment has been minimized.

Show comment Hide comment
@Sovietaced

Sovietaced Mar 8, 2015

Thank you!

Thank you!

@carlosloslas

This comment has been minimized.

Show comment Hide comment
@carlosloslas

carlosloslas Mar 15, 2015

Thanks very much for a great template!

Thanks very much for a great template!

@angajime

This comment has been minimized.

Show comment Hide comment
@angajime

angajime Apr 17, 2015

Great template, thank you very much!

Great template, thank you very much!

@Plimsky

This comment has been minimized.

Show comment Hide comment
@Plimsky

Plimsky Jul 3, 2015

Nice ! Thanks :-D

Plimsky commented Jul 3, 2015

Nice ! Thanks :-D

@rayfoss

This comment has been minimized.

Show comment Hide comment
@rayfoss

rayfoss Jul 7, 2015

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

rayfoss commented Jul 7, 2015

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

@ccywch

This comment has been minimized.

Show comment Hide comment
@ccywch

ccywch Sep 16, 2015

Thanks a lot!

ccywch commented Sep 16, 2015

Thanks a lot!

@mitbal

This comment has been minimized.

Show comment Hide comment
@mitbal

mitbal Nov 27, 2015

This is helpful. Thank you

mitbal commented Nov 27, 2015

This is helpful. Thank you

@gkbluestocking

This comment has been minimized.

Show comment Hide comment
@gkbluestocking

gkbluestocking Dec 8, 2015

This is an excellent guide. Thank you.

This is an excellent guide. Thank you.

@colkito

This comment has been minimized.

Show comment Hide comment
@colkito

colkito Jan 12, 2016

great! thanks!

colkito commented Jan 12, 2016

great! thanks!

@sameerkhoja

This comment has been minimized.

Show comment Hide comment
@sameerkhoja

sameerkhoja Jan 13, 2016

Awesome, thanks!

Awesome, thanks!

@KevDoy

This comment has been minimized.

Show comment Hide comment
@KevDoy

KevDoy Jan 17, 2016

This is great. Thank you!

KevDoy commented Jan 17, 2016

This is great. Thank you!

@Herm71

This comment has been minimized.

Show comment Hide comment
@Herm71

Herm71 Jan 21, 2016

Nice template, thanks!

Herm71 commented Jan 21, 2016

Nice template, thanks!

@Laicure

This comment has been minimized.

Show comment Hide comment
@Laicure

Laicure Jan 25, 2016

Thanks! Nice template! <3

Laicure commented Jan 25, 2016

Thanks! Nice template! <3

@priyankinfinnov

This comment has been minimized.

Show comment Hide comment
@priyankinfinnov

priyankinfinnov Feb 7, 2016

nice

nice

@rohit2389

This comment has been minimized.

Show comment Hide comment
@rohit2389

rohit2389 Feb 22, 2016

Thanks a lot <3

Thanks a lot <3

@uilianries

This comment has been minimized.

Show comment Hide comment
@uilianries

uilianries Mar 6, 2016

Really useful! Tks!

Really useful! Tks!

@XiaoZYang

This comment has been minimized.

Show comment Hide comment
@XiaoZYang

XiaoZYang Apr 8, 2016

Thanks !

Thanks !

@cAtilre

This comment has been minimized.

Show comment Hide comment
@cAtilre

cAtilre Apr 19, 2016

This is great, thanks.

cAtilre commented Apr 19, 2016

This is great, thanks.

@arsalan-darbandi

This comment has been minimized.

Show comment Hide comment
@arsalan-darbandi

arsalan-darbandi Apr 21, 2016

Nice job!

Nice job!

@Karan-nassa

This comment has been minimized.

Show comment Hide comment
@Karan-nassa

Karan-nassa May 3, 2016

Really nice.

Really nice.

@AndrewDawes

This comment has been minimized.

Show comment Hide comment
@AndrewDawes

AndrewDawes May 4, 2016

Thanks very much.

Thanks very much.

@douglasdeodato

This comment has been minimized.

Show comment Hide comment
@douglasdeodato

douglasdeodato May 9, 2016

thanks

thanks

@IrfaanKamo

This comment has been minimized.

Show comment Hide comment
@IrfaanKamo

IrfaanKamo May 13, 2016

Thanks, exactly what I was looking for!

Thanks, exactly what I was looking for!

@S1v4

This comment has been minimized.

Show comment Hide comment
@S1v4

S1v4 May 14, 2016

Thank you!

S1v4 commented May 14, 2016

Thank you!

@kapoor-rakshit

This comment has been minimized.

Show comment Hide comment
@kapoor-rakshit

kapoor-rakshit May 16, 2016

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

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

@romamaslennikov

This comment has been minimized.

Show comment Hide comment
@romamaslennikov

romamaslennikov May 17, 2016

o ya ya

o ya ya

@romamaslennikov

This comment has been minimized.

Show comment Hide comment
@romamaslennikov

romamaslennikov May 17, 2016

thanks

thanks

@abjzb70

This comment has been minimized.

Show comment Hide comment
@abjzb70

abjzb70 May 22, 2016

thanks!!!

abjzb70 commented May 22, 2016

thanks!!!

@alissaom

This comment has been minimized.

Show comment Hide comment
@alissaom

alissaom May 26, 2016

Thank you!

Thank you!

@boompah

This comment has been minimized.

Show comment Hide comment
@boompah

boompah May 28, 2016

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

boompah commented May 28, 2016

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

@shyamalmunshi

This comment has been minimized.

Show comment Hide comment
@shyamalmunshi

shyamalmunshi Jun 15, 2016

Thank you, this was very helpful!

Thank you, this was very helpful!

@ox-harris

This comment has been minimized.

Show comment Hide comment
@ox-harris

ox-harris Jul 1, 2016

What the beginner me really needed

What the beginner me really needed

@myson1515

This comment has been minimized.

Show comment Hide comment
@myson1515

myson1515 Jul 23, 2016

thanks bro!

thanks bro!

@sfilhu

This comment has been minimized.

Show comment Hide comment
@sfilhu

sfilhu Aug 20, 2016

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

sfilhu commented Aug 20, 2016

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

@zaosoula

This comment has been minimized.

Show comment Hide comment
@zaosoula

zaosoula Aug 20, 2016

merci

merci

@khrishan

This comment has been minimized.

Show comment Hide comment
@khrishan

khrishan Aug 26, 2016

Thanks for this template :) Much Appreciated

Thanks for this template :) Much Appreciated

@sebacruzd

This comment has been minimized.

Show comment Hide comment
@sebacruzd

sebacruzd Aug 28, 2016

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

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

@Arthurturtle

This comment has been minimized.

Show comment Hide comment
@Arthurturtle

Arthurturtle Oct 7, 2016

PFUDOR

PFUDOR

@rojcosta

This comment has been minimized.

Show comment Hide comment
@rojcosta

rojcosta Oct 18, 2016

Thank you!

Thank you!

@nachodox

This comment has been minimized.

Show comment Hide comment
@nachodox

nachodox Oct 20, 2016

thx

thx

@Kitanga

This comment has been minimized.

Show comment Hide comment
@Kitanga

Kitanga Oct 20, 2016

Thank you!!

Kitanga commented Oct 20, 2016

Thank you!!

@210digitalmarketing

This comment has been minimized.

Show comment Hide comment
@210digitalmarketing

210digitalmarketing Oct 23, 2016

Thanks!

Thanks!

@tkaghdo

This comment has been minimized.

Show comment Hide comment
@tkaghdo

tkaghdo Oct 29, 2016

Thank you very much!

tkaghdo commented Oct 29, 2016

Thank you very much!

@navneet1075

This comment has been minimized.

Show comment Hide comment
@navneet1075

navneet1075 Nov 9, 2016

Thanks a lot . It really helped .

navneet1075 commented Nov 9, 2016

Thanks a lot . It really helped .

@accendino

This comment has been minimized.

Show comment Hide comment
@accendino

accendino Nov 21, 2016

Great template, thank`s a lot!

Great template, thank`s a lot!

@ebanfa

This comment has been minimized.

Show comment Hide comment
@ebanfa

ebanfa Nov 23, 2016

Great. Thanks

ebanfa commented Nov 23, 2016

Great. Thanks

@Rolandkuku

This comment has been minimized.

Show comment Hide comment
@Rolandkuku

Rolandkuku Nov 28, 2016

<3

<3

@WeeHong

This comment has been minimized.

Show comment Hide comment
@WeeHong

WeeHong Dec 12, 2016

Thank you for sharing. <3

WeeHong commented Dec 12, 2016

Thank you for sharing. <3

@AnythingTechPro

This comment has been minimized.

Show comment Hide comment
@AnythingTechPro

AnythingTechPro Dec 14, 2016

Thanks!

Thanks!

@jpbourgeon

This comment has been minimized.

Show comment Hide comment
@jpbourgeon

jpbourgeon Jan 2, 2017

Thank you

Thank you

@avinashbarfa

This comment has been minimized.

Show comment Hide comment
@avinashbarfa

avinashbarfa Jan 4, 2017

thanks

thanks

@richoseptaalfian

This comment has been minimized.

Show comment Hide comment
@richoseptaalfian

richoseptaalfian Jan 11, 2017

how his men dwonload

how his men dwonload

@kevinbazira

This comment has been minimized.

Show comment Hide comment
@kevinbazira

kevinbazira Jan 11, 2017

Thanks a bunch

Thanks a bunch

@jaysheelshah

This comment has been minimized.

Show comment Hide comment
@jaysheelshah

jaysheelshah Jan 16, 2017

Cool template. Thanks for sharing!

Cool template. Thanks for sharing!

@Odame

This comment has been minimized.

Show comment Hide comment
@Odame

Odame Jan 19, 2017

Thanks for sharing

Odame commented Jan 19, 2017

Thanks for sharing

@Nyakato

This comment has been minimized.

Show comment Hide comment
@Nyakato

Nyakato Jan 24, 2017

Thanks alot

Nyakato commented Jan 24, 2017

Thanks alot

@a13ks3y

This comment has been minimized.

Show comment Hide comment
@a13ks3y

a13ks3y Jan 24, 2017

Thank you!

a13ks3y commented Jan 24, 2017

Thank you!

@Colobri

This comment has been minimized.

Show comment Hide comment
@Colobri

Colobri Feb 1, 2017

Awesome!

Colobri commented Feb 1, 2017

Awesome!

@enajenkins

This comment has been minimized.

Show comment Hide comment
@enajenkins

enajenkins Feb 16, 2017

Thank you! Great guide :)

Thank you! Great guide :)

@haimerb

This comment has been minimized.

Show comment Hide comment
@haimerb

haimerb Feb 22, 2017

Thank you!

haimerb commented Feb 22, 2017

Thank you!

@Nikita-Sharma-94

This comment has been minimized.

Show comment Hide comment
@Nikita-Sharma-94

Nikita-Sharma-94 Feb 28, 2017

Thank you

Thank you

@danitome24

This comment has been minimized.

Show comment Hide comment
@danitome24

danitome24 Mar 6, 2017

๐Ÿ”

๐Ÿ”

@GirardR1006

This comment has been minimized.

Show comment Hide comment
@GirardR1006

GirardR1006 Apr 5, 2017

Thank for the template

Thank for the template

@Woiyl

This comment has been minimized.

Show comment Hide comment
@Woiyl

Woiyl Apr 13, 2017

Easy to integrate , thanks a lot !

Woiyl commented Apr 13, 2017

Easy to integrate , thanks a lot !

@oumarxy

This comment has been minimized.

Show comment Hide comment
@oumarxy

oumarxy May 11, 2017

Thank you

oumarxy commented May 11, 2017

Thank you

@azinio

This comment has been minimized.

Show comment Hide comment
@azinio

azinio May 26, 2017

Arigato u Gozaimasu

azinio commented May 26, 2017

Arigato u Gozaimasu

@winex01

This comment has been minimized.

Show comment Hide comment
@winex01

winex01 Jun 1, 2017

tnx. really appreciate it.

winex01 commented Jun 1, 2017

tnx. really appreciate it.

@manpreetzenefits

This comment has been minimized.

Show comment Hide comment
@manpreetzenefits

manpreetzenefits Jun 12, 2017

Thanks

Thanks

@AashitaK

This comment has been minimized.

Show comment Hide comment
@AashitaK

AashitaK Jun 19, 2017

Thanks!

Thanks!

@munyurangeri

This comment has been minimized.

Show comment Hide comment
@munyurangeri

munyurangeri Jun 21, 2017

Cool, that what I was looking for!
Thanks

Cool, that what I was looking for!
Thanks

@hinell

This comment has been minimized.

Show comment Hide comment
@hinell

hinell Jun 30, 2017

Thanks.
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. ๐Ÿ˜Š

hinell commented Jun 30, 2017

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

This comment has been minimized.

Show comment Hide comment
@fodilo

fodilo Jul 4, 2017

Thanks a lot

fodilo commented Jul 4, 2017

Thanks a lot

@jericrealubit

This comment has been minimized.

Show comment Hide comment
@jericrealubit

jericrealubit Jul 4, 2017

Cool! ;)

Cool! ;)

@levone

This comment has been minimized.

Show comment Hide comment
@levone

levone Jul 20, 2017

Thanks for this.

levone commented Jul 20, 2017

Thanks for this.

@ArnoldGitHub

This comment has been minimized.

Show comment Hide comment
@ArnoldGitHub

ArnoldGitHub Aug 9, 2017

Thank you

Thank you

@GoranNenadic

This comment has been minimized.

Show comment Hide comment
@GoranNenadic

GoranNenadic Aug 9, 2017

Nice!

Nice!

@aleccstansell

This comment has been minimized.

Show comment Hide comment
@aleccstansell

aleccstansell Sep 11, 2017

Thanks ๐Ÿ‘

Thanks ๐Ÿ‘

@shakapaul

This comment has been minimized.

Show comment Hide comment
@shakapaul

shakapaul Sep 15, 2017

Nice one. Thanks!

Nice one. Thanks!

@rus89

This comment has been minimized.

Show comment Hide comment
@rus89

rus89 Oct 3, 2017

Great. Thank you very much!

rus89 commented Oct 3, 2017

Great. Thank you very much!

@David8377

This comment has been minimized.

Show comment Hide comment
@David8377

David8377 Nov 11, 2017

This is very helpful.

This is very helpful.

@wpEntwickler

This comment has been minimized.

Show comment Hide comment
@wpEntwickler

wpEntwickler Dec 1, 2017

Thank you very much

Thank you very much

@hlopes7

This comment has been minimized.

Show comment Hide comment
@hlopes7

hlopes7 Dec 4, 2017

Thank you! :)

hlopes7 commented Dec 4, 2017

Thank you! :)

@Ismail788

This comment has been minimized.

Show comment Hide comment
@Ismail788

Ismail788 Dec 5, 2017

Well done! thanks :)

Well done! thanks :)

@rohun-tripathi

This comment has been minimized.

Show comment Hide comment
@rohun-tripathi

rohun-tripathi Dec 15, 2017

Nice!

Nice!

@white-mage

This comment has been minimized.

Show comment Hide comment
@white-mage

white-mage Dec 30, 2017

Awesome! Thanks!

Awesome! Thanks!

@maximousblk

This comment has been minimized.

Show comment Hide comment
@maximousblk

maximousblk Jan 6, 2018

Great one!!

Great one!!

@naumanafsar

This comment has been minimized.

Show comment Hide comment
@naumanafsar

naumanafsar Feb 27, 2018

thanks ๐Ÿ‘

thanks ๐Ÿ‘

@RCMiron

This comment has been minimized.

Show comment Hide comment
@RCMiron

RCMiron Mar 4, 2018

Cool!

RCMiron commented Mar 4, 2018

Cool!

@ayush3899

This comment has been minimized.

Show comment Hide comment
@ayush3899

ayush3899 Mar 5, 2018

thanks!!

thanks!!

@Sujay-Muramalla

This comment has been minimized.

Show comment Hide comment
@Sujay-Muramalla

Sujay-Muramalla Mar 25, 2018

Thanks a lot!

Thanks a lot!

@jonasespelita

This comment has been minimized.

Show comment Hide comment
@jonasespelita

jonasespelita Apr 18, 2018

Salamat po!

Salamat po!

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