Skip to content

Instantly share code, notes, and snippets.

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

Copy link

@ghost ghost commented Dec 7, 2013

Thank you :)

@aloisdg

This comment has been minimized.

Copy link

@aloisdg aloisdg commented Feb 19, 2014

Thanks !

@BrainCrumbz

This comment has been minimized.

Copy link

@BrainCrumbz BrainCrumbz commented May 6, 2014

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

@Sovietaced

This comment has been minimized.

Copy link

@Sovietaced Sovietaced commented Mar 8, 2015

Thank you!

@carlosloslas

This comment has been minimized.

Copy link

@carlosloslas carlosloslas commented Mar 15, 2015

Thanks very much for a great template!

@angajime

This comment has been minimized.

Copy link

@angajime angajime commented Apr 17, 2015

Great template, thank you very much!

@Plimsky

This comment has been minimized.

Copy link

@Plimsky Plimsky commented Jul 3, 2015

Nice ! Thanks :-D

@rayfoss

This comment has been minimized.

Copy link

@rayfoss rayfoss commented Jul 7, 2015

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

@ccywch

This comment has been minimized.

Copy link

@ccywch ccywch commented Sep 16, 2015

Thanks a lot!

@mitbal

This comment has been minimized.

Copy link

@mitbal mitbal commented Nov 27, 2015

This is helpful. Thank you

@gkbluestocking

This comment has been minimized.

Copy link

@gkbluestocking gkbluestocking commented Dec 8, 2015

This is an excellent guide. Thank you.

@bycolco

This comment has been minimized.

Copy link

@bycolco bycolco commented Jan 12, 2016

great! thanks!

@sameerkhoja

This comment has been minimized.

Copy link

@sameerkhoja sameerkhoja commented Jan 13, 2016

Awesome, thanks!

@KevDoy

This comment has been minimized.

Copy link

@KevDoy KevDoy commented Jan 17, 2016

This is great. Thank you!

@Herm71

This comment has been minimized.

Copy link

@Herm71 Herm71 commented Jan 21, 2016

Nice template, thanks!

@Laicure

This comment has been minimized.

Copy link

@Laicure Laicure commented Jan 25, 2016

Thanks! Nice template! <3

@priyankinfinnov

This comment has been minimized.

Copy link

@priyankinfinnov priyankinfinnov commented Feb 7, 2016

nice

@rohit2389

This comment has been minimized.

Copy link

@rohit2389 rohit2389 commented Feb 22, 2016

Thanks a lot <3

@uilianries

This comment has been minimized.

Copy link

@uilianries uilianries commented Mar 6, 2016

Really useful! Tks!

@xiaozongyang

This comment has been minimized.

Copy link

@xiaozongyang xiaozongyang commented Apr 8, 2016

Thanks !

@cAtilre

This comment has been minimized.

Copy link

@cAtilre cAtilre commented Apr 19, 2016

This is great, thanks.

@arsalan-darbandi

This comment has been minimized.

Copy link

@arsalan-darbandi arsalan-darbandi commented Apr 21, 2016

Nice job!

@Karan-nassa

This comment has been minimized.

Copy link

@Karan-nassa Karan-nassa commented May 3, 2016

Really nice.

@AndrewDawes

This comment has been minimized.

Copy link

@AndrewDawes AndrewDawes commented May 4, 2016

Thanks very much.

@douglasdeodato

This comment has been minimized.

Copy link

@douglasdeodato douglasdeodato commented May 9, 2016

thanks

@IrfaanKamo

This comment has been minimized.

Copy link

@IrfaanKamo IrfaanKamo commented May 13, 2016

Thanks, exactly what I was looking for!

@S1v4

This comment has been minimized.

Copy link

@S1v4 S1v4 commented May 14, 2016

Thank you!

@kapoor-rakshit

This comment has been minimized.

Copy link

@kapoor-rakshit kapoor-rakshit commented May 16, 2016

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.

Copy link

@romamaslennikov romamaslennikov commented May 17, 2016

o ya ya

@romamaslennikov

This comment has been minimized.

Copy link

@romamaslennikov romamaslennikov commented May 17, 2016

thanks

@abjzb70

This comment has been minimized.

Copy link

@abjzb70 abjzb70 commented May 22, 2016

thanks!!!

@alissaom

This comment has been minimized.

Copy link

@alissaom alissaom commented May 26, 2016

Thank you!

@boompah

This comment has been minimized.

Copy link

@boompah boompah commented May 28, 2016

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

@shyamalmunshi

This comment has been minimized.

Copy link

@shyamalmunshi shyamalmunshi commented Jun 15, 2016

Thank you, this was very helpful!

@ox-harris

This comment has been minimized.

Copy link

@ox-harris ox-harris commented Jul 1, 2016

What the beginner me really needed

@myson1515

This comment has been minimized.

Copy link

@myson1515 myson1515 commented Jul 23, 2016

thanks bro!

@sfilhu

This comment has been minimized.

Copy link

@sfilhu 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.

Copy link

@zaosoula zaosoula commented Aug 20, 2016

merci

@khrishan

This comment has been minimized.

Copy link

@khrishan khrishan commented Aug 26, 2016

Thanks for this template :) Much Appreciated

@sebacruzd

This comment has been minimized.

Copy link

@sebacruzd sebacruzd commented Aug 28, 2016

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

@Arthurturtle

This comment has been minimized.

Copy link

@Arthurturtle Arthurturtle commented Oct 7, 2016

PFUDOR

@rojcosta

This comment has been minimized.

Copy link

@rojcosta rojcosta commented Oct 18, 2016

Thank you!

@nachodox

This comment has been minimized.

Copy link

@nachodox nachodox commented Oct 20, 2016

thx

@Kitanga

This comment has been minimized.

Copy link

@Kitanga Kitanga commented Oct 20, 2016

Thank you!!

@210digitalmarketing

This comment has been minimized.

Copy link

@210digitalmarketing 210digitalmarketing commented Oct 23, 2016

Thanks!

@tkaghdo

This comment has been minimized.

Copy link

@tkaghdo tkaghdo commented Oct 29, 2016

Thank you very much!

@navneet1075

This comment has been minimized.

Copy link

@navneet1075 navneet1075 commented Nov 9, 2016

Thanks a lot . It really helped .

@accendino

This comment has been minimized.

Copy link

@accendino accendino commented Nov 21, 2016

Great template, thank`s a lot!

@ebanfa

This comment has been minimized.

Copy link

@ebanfa ebanfa commented Nov 23, 2016

Great. Thanks

@Rolandkuku

This comment has been minimized.

Copy link

@Rolandkuku Rolandkuku commented Nov 28, 2016

<3

@WeeHong

This comment has been minimized.

Copy link

@WeeHong WeeHong commented Dec 12, 2016

Thank you for sharing. <3

@cmarshall108

This comment has been minimized.

Copy link

@cmarshall108 cmarshall108 commented Dec 14, 2016

Thanks!

@jpbourgeon

This comment has been minimized.

Copy link

@jpbourgeon jpbourgeon commented Jan 2, 2017

Thank you

@avinashbarfa

This comment has been minimized.

Copy link

@avinashbarfa avinashbarfa commented Jan 4, 2017

thanks

@richoseptaalfian

This comment has been minimized.

Copy link

@richoseptaalfian richoseptaalfian commented Jan 11, 2017

how his men dwonload

@kevinbazira

This comment has been minimized.

Copy link

@kevinbazira kevinbazira commented Jan 11, 2017

Thanks a bunch

@jaysheelshah

This comment has been minimized.

Copy link

@jaysheelshah jaysheelshah commented Jan 16, 2017

Cool template. Thanks for sharing!

@Odame

This comment has been minimized.

Copy link

@Odame Odame commented Jan 19, 2017

Thanks for sharing

@Nyakato

This comment has been minimized.

Copy link

@Nyakato Nyakato commented Jan 24, 2017

Thanks alot

@a13ks3y

This comment has been minimized.

Copy link

@a13ks3y a13ks3y commented Jan 24, 2017

Thank you!

@RobinTollerHovler

This comment has been minimized.

Copy link

@RobinTollerHovler RobinTollerHovler commented Feb 1, 2017

Awesome!

@enajenkins

This comment has been minimized.

Copy link

@enajenkins enajenkins commented Feb 16, 2017

Thank you! Great guide :)

@haimerb

This comment has been minimized.

Copy link

@haimerb haimerb commented Feb 22, 2017

Thank you!

@Nikita-Sharma-94

This comment has been minimized.

Copy link

@Nikita-Sharma-94 Nikita-Sharma-94 commented Feb 28, 2017

Thank you

@danitome24

This comment has been minimized.

Copy link

@danitome24 danitome24 commented Mar 6, 2017

🔝

@GirardR1006

This comment has been minimized.

Copy link

@GirardR1006 GirardR1006 commented Apr 5, 2017

Thank for the template

@Woiyl

This comment has been minimized.

Copy link

@Woiyl Woiyl commented Apr 13, 2017

Easy to integrate , thanks a lot !

@oumarxy

This comment has been minimized.

Copy link

@oumarxy oumarxy commented May 11, 2017

Thank you

@ghost

This comment has been minimized.

Copy link

@ghost ghost commented May 26, 2017

Arigato u Gozaimasu

@winex01

This comment has been minimized.

Copy link

@winex01 winex01 commented Jun 1, 2017

tnx. really appreciate it.

@manpreetzenefits

This comment has been minimized.

Copy link

@manpreetzenefits manpreetzenefits commented Jun 12, 2017

Thanks

@AashitaK

This comment has been minimized.

Copy link

@AashitaK AashitaK commented Jun 19, 2017

Thanks!

@munyurangeri

This comment has been minimized.

Copy link

@munyurangeri munyurangeri commented Jun 21, 2017

Cool, that what I was looking for!
Thanks

@hinell

This comment has been minimized.

Copy link

@hinell 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.

Copy link

@fodilo fodilo commented Jul 4, 2017

Thanks a lot

@jericrealubit

This comment has been minimized.

Copy link

@jericrealubit jericrealubit commented Jul 4, 2017

Cool! ;)

@levone

This comment has been minimized.

Copy link

@levone levone commented Jul 20, 2017

Thanks for this.

@ArnoldGitHub

This comment has been minimized.

Copy link

@ArnoldGitHub ArnoldGitHub commented Aug 9, 2017

Thank you

@GoranNenadic

This comment has been minimized.

Copy link

@GoranNenadic GoranNenadic commented Aug 9, 2017

Nice!

@aleccstansell

This comment has been minimized.

Copy link

@aleccstansell aleccstansell commented Sep 11, 2017

Thanks 👍

@testyourcodenow

This comment has been minimized.

Copy link

@testyourcodenow testyourcodenow commented Sep 15, 2017

Nice one. Thanks!

@rus89

This comment has been minimized.

Copy link

@rus89 rus89 commented Oct 3, 2017

Great. Thank you very much!

@David8377

This comment has been minimized.

Copy link

@David8377 David8377 commented Nov 11, 2017

This is very helpful.

@kneupmedia

This comment has been minimized.

Copy link

@kneupmedia kneupmedia commented Dec 1, 2017

Thank you very much

@henriqueln7

This comment has been minimized.

Copy link

@henriqueln7 henriqueln7 commented Dec 4, 2017

Thank you! :)

@Ismail788

This comment has been minimized.

Copy link

@Ismail788 Ismail788 commented Dec 5, 2017

Well done! thanks :)

@rohun-tripathi

This comment has been minimized.

Copy link

@rohun-tripathi rohun-tripathi commented Dec 15, 2017

Nice!

@white-mage

This comment has been minimized.

Copy link

@white-mage white-mage commented Dec 30, 2017

Awesome! Thanks!

@maximousblk

This comment has been minimized.

Copy link

@maximousblk maximousblk commented Jan 6, 2018

Great one!!

@naumanafsar

This comment has been minimized.

Copy link

@naumanafsar naumanafsar commented Feb 27, 2018

thanks 👍

@RCMiron

This comment has been minimized.

Copy link

@RCMiron RCMiron commented Mar 4, 2018

Cool!

@ayush3899

This comment has been minimized.

Copy link

@ayush3899 ayush3899 commented Mar 5, 2018

thanks!!

@Sujay-Muramalla

This comment has been minimized.

Copy link

@Sujay-Muramalla Sujay-Muramalla commented Mar 25, 2018

Thanks a lot!

@jonasespelita

This comment has been minimized.

Copy link

@jonasespelita jonasespelita commented Apr 18, 2018

Salamat po!

@10007327

This comment has been minimized.

Copy link

@10007327 10007327 commented May 15, 2018

hi

@Clucier17

This comment has been minimized.

Copy link

@Clucier17 Clucier17 commented Sep 27, 2018

I still don't know how this?

@thibaultferrier

This comment has been minimized.

Copy link

@thibaultferrier thibaultferrier commented Oct 5, 2018

thank you!

@gamejuel87

This comment has been minimized.

Copy link

@gamejuel87 gamejuel87 commented Feb 14, 2019

Thank you for sharing !

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