Create a gist now

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A template to make good README.md

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
@alehlipka

This comment has been minimized.

Show comment
Hide comment

Thank you

@Villanuevand

This comment has been minimized.

Show comment
Hide comment
@Villanuevand

Villanuevand Sep 28, 2016

Awesome template!
Thanks ... πŸ‘

Awesome template!
Thanks ... πŸ‘

@GeorgeTaveras1231

This comment has been minimized.

Show comment
Hide comment
@GeorgeTaveras1231

GeorgeTaveras1231 Oct 2, 2016

Awesome template!

You have a typo right underneath the installing section. It says Stay what the step will be.

GeorgeTaveras1231 commented Oct 2, 2016

Awesome template!

You have a typo right underneath the installing section. It says Stay what the step will be.

@PurpleBooth

This comment has been minimized.

Show comment
Hide comment
@PurpleBooth

PurpleBooth Oct 2, 2016

ooh! good catch, fixed πŸ˜„

Owner

PurpleBooth commented Oct 2, 2016

ooh! good catch, fixed πŸ˜„

@ProElbs

This comment has been minimized.

Show comment
Hide comment
@ProElbs

ProElbs Oct 4, 2016

Thank you very much, very usefull template !

ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !

@justinrains

This comment has been minimized.

Show comment
Hide comment

Thanks!

@LocalMicro

This comment has been minimized.

Show comment
Hide comment
@LocalMicro

LocalMicro Oct 12, 2016

Thanks, just what I needed to help me write something short and clear.

Thanks, just what I needed to help me write something short and clear.

@dtgoitia

This comment has been minimized.

Show comment
Hide comment
@dtgoitia

dtgoitia Oct 16, 2016

Clear and complete. Thanks a lot!

Clear and complete. Thanks a lot!

@JosefVitu

This comment has been minimized.

Show comment
Hide comment
@JosefVitu

JosefVitu Oct 17, 2016

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites

@PurpleBooth

This comment has been minimized.

Show comment
Hide comment
@PurpleBooth

PurpleBooth Oct 17, 2016

Fixed! Thanks πŸ˜„

Owner

PurpleBooth commented Oct 17, 2016

Fixed! Thanks πŸ˜„

@desfero

This comment has been minimized.

Show comment
Hide comment
@desfero

desfero Oct 20, 2016

thanks :)

desfero commented Oct 20, 2016

thanks :)

@cancinos

This comment has been minimized.

Show comment
Hide comment
@cancinos

cancinos Oct 21, 2016

Really nice! Thanks for this guidance!

Really nice! Thanks for this guidance!

@surawinfo

This comment has been minimized.

Show comment
Hide comment

Thanks!

@f2dmarques

This comment has been minimized.

Show comment
Hide comment
@f2dmarques

f2dmarques Nov 4, 2016

Excellent template! Thanks!

Excellent template! Thanks!

@RCSM

This comment has been minimized.

Show comment
Hide comment
@RCSM

RCSM Nov 7, 2016

Helped a lot, thanks πŸ‘

RCSM commented Nov 7, 2016

Helped a lot, thanks πŸ‘

@andresroberto

This comment has been minimized.

Show comment
Hide comment
@andresroberto

andresroberto Nov 17, 2016

Thank you very much for this awesome template! πŸ‘

andresroberto commented Nov 17, 2016

Thank you very much for this awesome template! πŸ‘

@Sylvainkossi

This comment has been minimized.

Show comment
Hide comment

Excellent!

@lamagnotti

This comment has been minimized.

Show comment
Hide comment
@lamagnotti

lamagnotti Nov 26, 2016

Awesome! Thank you!

Awesome! Thank you!

@44r0n

This comment has been minimized.

Show comment
Hide comment
@44r0n

44r0n Nov 27, 2016

So helpful! Thank you!

44r0n commented Nov 27, 2016

So helpful! Thank you!

@greyfoxamine

This comment has been minimized.

Show comment
Hide comment
@greyfoxamine

greyfoxamine Dec 5, 2016

oh my GOD thanks a lot

oh my GOD thanks a lot

@ShawnBin

This comment has been minimized.

Show comment
Hide comment
@ShawnBin

ShawnBin Dec 16, 2016

Thank you!

Thank you!

@navkelley

This comment has been minimized.

Show comment
Hide comment
@navkelley

navkelley Dec 18, 2016

Thank you! This helped me so much.

Thank you! This helped me so much.

@afullstopdot

This comment has been minimized.

Show comment
Hide comment
@afullstopdot

afullstopdot Dec 19, 2016

Thank you so much, really helpful for new developers.

Thank you so much, really helpful for new developers.

@jmoralesce

This comment has been minimized.

Show comment
Hide comment

Thank you!

@rahulsingh8

This comment has been minimized.

Show comment
Hide comment
@rahulsingh8

rahulsingh8 Dec 27, 2016

Thanks a ton πŸ‘πŸ‘

Thanks a ton πŸ‘πŸ‘

@anandprajapati1

This comment has been minimized.

Show comment
Hide comment
@anandprajapati1

anandprajapati1 Jan 2, 2017

Very useful. Thanks a lot!

Very useful. Thanks a lot!

@ctlong

This comment has been minimized.

Show comment
Hide comment
@ctlong

ctlong Jan 4, 2017

Wonderful, thanks!

ctlong commented Jan 4, 2017

Wonderful, thanks!

@RyanTheMyan

This comment has been minimized.

Show comment
Hide comment

Thanks!

@kevinbazira

This comment has been minimized.

Show comment
Hide comment
@kevinbazira

kevinbazira Jan 11, 2017

Thanks a bunch

Thanks a bunch

@awilliams

This comment has been minimized.

Show comment
Hide comment
@awilliams

awilliams Jan 13, 2017

Thanks for this

Thanks for this

@sicdigital

This comment has been minimized.

Show comment
Hide comment
@sicdigital

sicdigital Jan 24, 2017

This is really cool. Thanks!

This is really cool. Thanks!

@ldecamp

This comment has been minimized.

Show comment
Hide comment
@ldecamp

ldecamp Jan 30, 2017

Really cool template. Thanks.

ldecamp commented Jan 30, 2017

Really cool template. Thanks.

@8eni

This comment has been minimized.

Show comment
Hide comment
@8eni

8eni Feb 7, 2017

great template

8eni commented Feb 7, 2017

great template

@dineshraj01

This comment has been minimized.

Show comment
Hide comment
@dineshraj01

dineshraj01 Feb 8, 2017

Time saviour! thank you !

Time saviour! thank you !

@calmjohnson

This comment has been minimized.

Show comment
Hide comment
@calmjohnson

calmjohnson Feb 12, 2017

Thanks a lot!

Thanks a lot!

@hsjoihs

This comment has been minimized.

Show comment
Hide comment

hsjoihs commented Feb 13, 2017

Thanks!

@Renato2012

This comment has been minimized.

Show comment
Hide comment

Thank you!

@christinach

This comment has been minimized.

Show comment
Hide comment
@christinach

christinach Feb 17, 2017

Thank you! :)

Thank you! :)

@nirodg

This comment has been minimized.

Show comment
Hide comment
@nirodg

nirodg Feb 19, 2017

Thank you, nice job!

nirodg commented Feb 19, 2017

Thank you, nice job!

@divakarsingh

This comment has been minimized.

Show comment
Hide comment
@divakarsingh

divakarsingh Feb 19, 2017

Good one, provides quick help.

Good one, provides quick help.

@Borange

This comment has been minimized.

Show comment
Hide comment
@Borange

Borange Feb 22, 2017

Great job! Thanks!

Borange commented Feb 22, 2017

Great job! Thanks!

@reneabreu

This comment has been minimized.

Show comment
Hide comment
@reneabreu

reneabreu Mar 2, 2017

Thank You! (:

Thank You! (:

@bnzene

This comment has been minimized.

Show comment
Hide comment
@bnzene

bnzene Mar 4, 2017

Thank you!

bnzene commented Mar 4, 2017

Thank you!

@kennorris

This comment has been minimized.

Show comment
Hide comment
@kennorris

kennorris Mar 5, 2017

Perfect - thank you!

Perfect - thank you!

@JaeDukSeo

This comment has been minimized.

Show comment
Hide comment
@JaeDukSeo

JaeDukSeo Mar 11, 2017

Thank you!

Thank you!

@Will-B-Chang

This comment has been minimized.

Show comment
Hide comment

Thank you!

@crustafari

This comment has been minimized.

Show comment
Hide comment
@crustafari

crustafari Mar 22, 2017

Thank you!!

Thank you!!

@tiagodavi70

This comment has been minimized.

Show comment
Hide comment

Thanks man!

@AndreMommert

This comment has been minimized.

Show comment
Hide comment
@AndreMommert

AndreMommert Mar 26, 2017

Thank you πŸ‘

Thank you πŸ‘

@handsfreemc

This comment has been minimized.

Show comment
Hide comment
@handsfreemc

handsfreemc Mar 28, 2017

Appreciate this greatly!

Appreciate this greatly!

@mrm8488

This comment has been minimized.

Show comment
Hide comment

mrm8488 commented Mar 29, 2017

Thanks

@sinamomken

This comment has been minimized.

Show comment
Hide comment
@sinamomken

sinamomken Mar 29, 2017

How could I fork it to use later?

How could I fork it to use later?

@pramod1988

This comment has been minimized.

Show comment
Hide comment
@pramod1988

pramod1988 Mar 29, 2017

Thank you for creating this wonderful template. This is very helpful for me.

Thank you for creating this wonderful template. This is very helpful for me.

@sfauch1

This comment has been minimized.

Show comment
Hide comment

sfauch1 commented Mar 29, 2017

Thanks

@guiguiboy

This comment has been minimized.

Show comment
Hide comment

Thanks !

@daquilino

This comment has been minimized.

Show comment
Hide comment
@daquilino

daquilino Mar 31, 2017

Thanks. Great resource.
BTW typo under Installing. 'how' instead of 'have'.

Thanks. Great resource.
BTW typo under Installing. 'how' instead of 'have'.

@LappleApple

This comment has been minimized.

Show comment
Hide comment
@LappleApple

LappleApple Apr 1, 2017

+1. Will add this to our/Zalando's own how-to as an alternate resource to this template.

LappleApple commented Apr 1, 2017

+1. Will add this to our/Zalando's own how-to as an alternate resource to this template.

@Krishna80

This comment has been minimized.

Show comment
Hide comment
@Krishna80

Krishna80 Apr 4, 2017

thanks a lot nice temp

thanks a lot nice temp

@Josica

This comment has been minimized.

Show comment
Hide comment
@Josica

Josica Apr 5, 2017

Thank you!

Josica commented Apr 5, 2017

Thank you!

@mskonline

This comment has been minimized.

Show comment
Hide comment
@mskonline

mskonline Apr 5, 2017

Thanks...!

Thanks...!

@itsonlybarney

This comment has been minimized.

Show comment
Hide comment
@itsonlybarney

itsonlybarney Apr 6, 2017

Thanks so much for sharing this template. It is exactly what i need for the current project that I am working on. I will certainly tweak it a little but otherwise this is a good starting point.

Thanks so much for sharing this template. It is exactly what i need for the current project that I am working on. I will certainly tweak it a little but otherwise this is a good starting point.

@guiguiboy

This comment has been minimized.

Show comment
Hide comment
@guiguiboy

guiguiboy Apr 6, 2017

I think it would it be interesting to add a changelog section, optional of course. In this section, there would be the additions sorted by releases but also the deprecated features. What do you think?

I think it would it be interesting to add a changelog section, optional of course. In this section, there would be the additions sorted by releases but also the deprecated features. What do you think?

@pau-lo

This comment has been minimized.

Show comment
Hide comment
@pau-lo

pau-lo Apr 6, 2017

Great, thank you.

pau-lo commented Apr 6, 2017

Great, thank you.

@joseluizcoe

This comment has been minimized.

Show comment
Hide comment

<3 <3 <3

@SugoiNelson

This comment has been minimized.

Show comment
Hide comment
@SugoiNelson

SugoiNelson Apr 19, 2017

This is exactly what I needed, thank you! <3

This is exactly what I needed, thank you! <3

@Kayla425

This comment has been minimized.

Show comment
Hide comment
@Kayla425

Kayla425 Apr 19, 2017

Perfect! Thank you.

Perfect! Thank you.

@sunnydayw

This comment has been minimized.

Show comment
Hide comment
@sunnydayw

sunnydayw Apr 21, 2017

Love it <3

Love it <3

@VisionYi

This comment has been minimized.

Show comment
Hide comment
@VisionYi

VisionYi Apr 23, 2017

Thank a lot ! Good template.

Thank a lot ! Good template.

@KenrySanchez

This comment has been minimized.

Show comment
Hide comment
@KenrySanchez

KenrySanchez Apr 23, 2017

Thank you man. it's very usefull πŸ‘

Thank you man. it's very usefull πŸ‘

@PRO2XY

This comment has been minimized.

Show comment
Hide comment
@PRO2XY

PRO2XY Apr 28, 2017

Oh nice! Thanks a lot! Finally I got around to pushing my projects to github, only to realize I didn't quite know how to structure a good readme. Now I can use this as a base and edit the relevant sections for my projects, so that the viewers can see what the repository actually is all about!

Some things that would be good to add (specially for hardware related projects) would be:

  • Screenshots / Images of the set-up (for hardware include schematic / wiring diagram)
  • References (similar to acknowledgements, but may be useful to 'refer' to a particular claim/issue/reasoning.
  • Badges (which I don't know much yet about)

Thanks!

BTW, here's a guide to markdown (as listed under the comments box), the styling system used on github.

PRO2XY commented Apr 28, 2017

Oh nice! Thanks a lot! Finally I got around to pushing my projects to github, only to realize I didn't quite know how to structure a good readme. Now I can use this as a base and edit the relevant sections for my projects, so that the viewers can see what the repository actually is all about!

Some things that would be good to add (specially for hardware related projects) would be:

  • Screenshots / Images of the set-up (for hardware include schematic / wiring diagram)
  • References (similar to acknowledgements, but may be useful to 'refer' to a particular claim/issue/reasoning.
  • Badges (which I don't know much yet about)

Thanks!

BTW, here's a guide to markdown (as listed under the comments box), the styling system used on github.

@KikeVen

This comment has been minimized.

Show comment
Hide comment
@KikeVen

KikeVen May 6, 2017

Thanks !

KikeVen commented May 6, 2017

Thanks !

@brunobc182

This comment has been minimized.

Show comment
Hide comment
@brunobc182

brunobc182 May 10, 2017

WoW! Nice, thanks!

WoW! Nice, thanks!

@simonpo

This comment has been minimized.

Show comment
Hide comment
@simonpo

simonpo May 16, 2017

Helpful file, thank-you! Unfortunately I am a member of the spelling police, and think you should substitute "whose" for "who's" in the line "Hat tip to anyone who's code was used" (as who's is a contraction of "who is", not the possessive form of "who")

simonpo commented May 16, 2017

Helpful file, thank-you! Unfortunately I am a member of the spelling police, and think you should substitute "whose" for "who's" in the line "Hat tip to anyone who's code was used" (as who's is a contraction of "who is", not the possessive form of "who")

@melluru

This comment has been minimized.

Show comment
Hide comment
@melluru

melluru May 17, 2017

Thanks for sharing.. it is very structured & presentable. Followed it as a template.. it was like learn and do in one go.

melluru commented May 17, 2017

Thanks for sharing.. it is very structured & presentable. Followed it as a template.. it was like learn and do in one go.

@JoseCage

This comment has been minimized.

Show comment
Hide comment
@JoseCage

JoseCage May 18, 2017

Very useful.. Thanks πŸ‘

Very useful.. Thanks πŸ‘

@irinadrozdova

This comment has been minimized.

Show comment
Hide comment
@irinadrozdova

irinadrozdova May 19, 2017

Oh! Awesome! Thanks!

Oh! Awesome! Thanks!

@mpruessmeier

This comment has been minimized.

Show comment
Hide comment
@mpruessmeier

mpruessmeier May 20, 2017

Thank you, very usefull πŸ‘

Thank you, very usefull πŸ‘

@mhtsharma948

This comment has been minimized.

Show comment
Hide comment
@mhtsharma948

mhtsharma948 May 23, 2017

Really useful!!
Thanks!! :)

Really useful!!
Thanks!! :)

@kgb1420

This comment has been minimized.

Show comment
Hide comment
@kgb1420

kgb1420 May 23, 2017

Beautiful template, thank you.
Typo under Acknowledgements--should be "anyone whose code was used"

kgb1420 commented May 23, 2017

Beautiful template, thank you.
Typo under Acknowledgements--should be "anyone whose code was used"

@toni-rmc

This comment has been minimized.

Show comment
Hide comment
@toni-rmc

toni-rmc May 29, 2017

I think you have a wrong wording here:

"A step by step series of examples that tell you have to get a development env running"

I think you meant how?

I think you have a wrong wording here:

"A step by step series of examples that tell you have to get a development env running"

I think you meant how?

@TARPTAEYA

This comment has been minimized.

Show comment
Hide comment
@TARPTAEYA

TARPTAEYA Jun 5, 2017

Great job to benefit beginners

Great job to benefit beginners

@burakodabas

This comment has been minimized.

Show comment
Hide comment
@burakodabas

burakodabas Jun 5, 2017

thank you. good tips for beginners

thank you. good tips for beginners

@willrp

This comment has been minimized.

Show comment
Hide comment

willrp commented Jun 7, 2017

Thanks

@afmguedes

This comment has been minimized.

Show comment
Hide comment
@afmguedes

afmguedes Jun 12, 2017

Amazing, thanks

Amazing, thanks

@LittaPanda

This comment has been minimized.

Show comment
Hide comment
@LittaPanda

LittaPanda Jun 15, 2017

Thanks a lot! You rocks!

Thanks a lot! You rocks!

@ub

This comment has been minimized.

Show comment
Hide comment
@ub

ub Jun 17, 2017

Thank you!

ub commented Jun 17, 2017

Thank you!

@guruglen

This comment has been minimized.

Show comment
Hide comment
@guruglen

guruglen Jun 19, 2017

This is Great. Thanks a lot.

This is Great. Thanks a lot.

@pankajvasnanitech123

This comment has been minimized.

Show comment
Hide comment
@pankajvasnanitech123

pankajvasnanitech123 Jun 20, 2017

Very useful Readme template. Thanks.

Very useful Readme template. Thanks.

@urzolaj

This comment has been minimized.

Show comment
Hide comment
@urzolaj

urzolaj Jun 21, 2017

Succinct! Exactly what I needed.

urzolaj commented Jun 21, 2017

Succinct! Exactly what I needed.

@eliasfernandez

This comment has been minimized.

Show comment
Hide comment

cool. thanks

@ppant

This comment has been minimized.

Show comment
Hide comment
@ppant

ppant Jun 24, 2017

Thanks. Very much needed.

ppant commented Jun 24, 2017

Thanks. Very much needed.

@sid226

This comment has been minimized.

Show comment
Hide comment

sid226 commented Jun 25, 2017

Thanks.

@gavrielCohen

This comment has been minimized.

Show comment
Hide comment

Thanks :-)

@SalmanTKhan

This comment has been minimized.

Show comment
Hide comment

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

@Saki-hanna

This comment has been minimized.

Show comment
Hide comment

Thanks

@justinfay

This comment has been minimized.

Show comment
Hide comment
@justinfay

justinfay Jul 4, 2017

Thank you.

Thank you.

@kevashcraft

This comment has been minimized.

Show comment
Hide comment
@kevashcraft

kevashcraft Jul 4, 2017

A great template! Thanks πŸ‘

A great template! Thanks πŸ‘

@randercarlos

This comment has been minimized.

Show comment
Hide comment
@randercarlos

randercarlos Jul 4, 2017

Very good. Save a lot of time.

Very good. Save a lot of time.

@simonmilz

This comment has been minimized.

Show comment
Hide comment

Thanks

@simondarke

This comment has been minimized.

Show comment
Hide comment
@simondarke

simondarke Jul 12, 2017

Thanks :) Really nice template.

Thanks :) Really nice template.

@david95thinkcode

This comment has been minimized.

Show comment
Hide comment
@david95thinkcode

david95thinkcode Jul 14, 2017

Very useful. Thank you :)

Very useful. Thank you :)

@mauroao

This comment has been minimized.

Show comment
Hide comment
@mauroao

mauroao Jul 19, 2017

Thanks !!!!

mauroao commented Jul 19, 2017

Thanks !!!!

@tonyfalabella

This comment has been minimized.

Show comment
Hide comment
@tonyfalabella

tonyfalabella Jul 19, 2017

Very nice. Would you perhaps consider creating a 2nd copy of this in AsciiDoc format?

Very nice. Would you perhaps consider creating a 2nd copy of this in AsciiDoc format?

@DracarysBZH

This comment has been minimized.

Show comment
Hide comment
@DracarysBZH

DracarysBZH Jul 20, 2017

Thank you ! Very nice template !

Thank you ! Very nice template !

@RobinTHOREL

This comment has been minimized.

Show comment
Hide comment

Thank a lot

@otaruMendez

This comment has been minimized.

Show comment
Hide comment
@otaruMendez

otaruMendez Jul 24, 2017

Nice template, possible typo in the Acknowledgements section whose for who's I think you meant.

Nice template, possible typo in the Acknowledgements section whose for who's I think you meant.

@estand25

This comment has been minimized.

Show comment
Hide comment
@estand25

estand25 Jul 25, 2017

Thank you, this is very helpful

Thank you, this is very helpful

@nvictor

This comment has been minimized.

Show comment
Hide comment

nvictor commented Jul 25, 2017

Thanks!

@TiphaineLAURENT

This comment has been minimized.

Show comment
Hide comment

Thanks !!

@Chofoteddy

This comment has been minimized.

Show comment
Hide comment
@Chofoteddy

Chofoteddy Jul 26, 2017

Thanks, it's very useful! πŸ˜ƒ

Thanks, it's very useful! πŸ˜ƒ

@PascalKu

This comment has been minimized.

Show comment
Hide comment
@PascalKu

PascalKu Jul 27, 2017

Thank you sooo much! It's awesome!

Thank you sooo much! It's awesome!

@jningtho

This comment has been minimized.

Show comment
Hide comment
@jningtho

jningtho Aug 6, 2017

Brilliant! Thank you for putting in so much for time compiling this READ for the noobs :)

jningtho commented Aug 6, 2017

Brilliant! Thank you for putting in so much for time compiling this READ for the noobs :)

@ArnoldGitHub

This comment has been minimized.

Show comment
Hide comment
@ArnoldGitHub

ArnoldGitHub Aug 9, 2017

Thank you, it is super useful

Thank you, it is super useful

@gokulkulkarni1987

This comment has been minimized.

Show comment
Hide comment
@gokulkulkarni1987

gokulkulkarni1987 Aug 10, 2017

Thanks a lot, its really helpful

Thanks a lot, its really helpful

@alireza-nouri

This comment has been minimized.

Show comment
Hide comment

Thanks a lot

@flakey-bit

This comment has been minimized.

Show comment
Hide comment
@flakey-bit

flakey-bit Aug 14, 2017

Awesome work - thanks a bunch!

Awesome work - thanks a bunch!

@simong33

This comment has been minimized.

Show comment
Hide comment
@simong33

simong33 Aug 15, 2017

Exactly what I was looking for, thanks!

Exactly what I was looking for, thanks!

@knapsacklabs

This comment has been minimized.

Show comment
Hide comment

Thanks

@gmbarroso

This comment has been minimized.

Show comment
Hide comment

Thanks!

@FridaySky

This comment has been minimized.

Show comment
Hide comment
@FridaySky

FridaySky Aug 19, 2017

This is a great template. Thanks so much! πŸ˜„

This is a great template. Thanks so much! πŸ˜„

@vikasFreelancer1913

This comment has been minimized.

Show comment
Hide comment
@vikasFreelancer1913

vikasFreelancer1913 Aug 20, 2017

Thank you so much, pretty helpful. I have one request can you also share how to call images for better documentation in md file.

Thank you so much, pretty helpful. I have one request can you also share how to call images for better documentation in md file.

@Osman8a

This comment has been minimized.

Show comment
Hide comment
@Osman8a

Osman8a Aug 21, 2017

Thank you!!

Osman8a commented Aug 21, 2017

Thank you!!

@belzaaron

This comment has been minimized.

Show comment
Hide comment
@belzaaron

belzaaron Aug 22, 2017

Good work, Scotty!

Good work, Scotty!

@sjgardiner

This comment has been minimized.

Show comment
Hide comment
@sjgardiner

sjgardiner Aug 23, 2017

This is excellent. Many thanks!

This is excellent. Many thanks!

@mel-michael

This comment has been minimized.

Show comment
Hide comment
@mel-michael

mel-michael Aug 28, 2017

This saved me a couple of minutes. Thanks.

This saved me a couple of minutes. Thanks.

@ch08532

This comment has been minimized.

Show comment
Hide comment
@ch08532

ch08532 Aug 31, 2017

Thanks! Clean and simple

ch08532 commented Aug 31, 2017

Thanks! Clean and simple

@settermjd

This comment has been minimized.

Show comment
Hide comment
@settermjd

settermjd Sep 4, 2017

Thank you many times over. This is really helping me out on so many projects.

Thank you many times over. This is really helping me out on so many projects.

@ttaratent

This comment has been minimized.

Show comment
Hide comment
@ttaratent

ttaratent Sep 5, 2017

wonderful! Thanks.

wonderful! Thanks.

@pravynandas

This comment has been minimized.

Show comment
Hide comment
@pravynandas

pravynandas Sep 5, 2017

Good to see a great template handy. And very happy to comments almost everyday from the day it drafted.

Good to see a great template handy. And very happy to comments almost everyday from the day it drafted.

@gerocha

This comment has been minimized.

Show comment
Hide comment
@gerocha

gerocha Sep 13, 2017

thank you very much

gerocha commented Sep 13, 2017

thank you very much

@irakligeek

This comment has been minimized.

Show comment
Hide comment
@irakligeek

irakligeek Sep 15, 2017

Very useful, thanks!

Very useful, thanks!

@AlksAlena

This comment has been minimized.

Show comment
Hide comment
@AlksAlena

AlksAlena Sep 21, 2017

Thank you ! πŸ₯‡

Thank you ! πŸ₯‡

@3q12

This comment has been minimized.

Show comment
Hide comment
@3q12

3q12 Sep 22, 2017

Thank you

3q12 commented Sep 22, 2017

Thank you

@MashRoofa

This comment has been minimized.

Show comment
Hide comment
@MashRoofa

MashRoofa Sep 22, 2017

Thank you!

Thank you!

@alyssonalvaran

This comment has been minimized.

Show comment
Hide comment

Thank you!

@brandonSc

This comment has been minimized.

Show comment
Hide comment
@brandonSc

brandonSc Sep 27, 2017

Very nice!

Very nice!

@desiraefreedman

This comment has been minimized.

Show comment
Hide comment

Thank you!

@cynthiayu

This comment has been minimized.

Show comment
Hide comment
@cynthiayu

cynthiayu Oct 2, 2017

Thank you so much! It's so well written and I'm using this for my projects. πŸ’ƒ

Thank you so much! It's so well written and I'm using this for my projects. πŸ’ƒ

@ssw239

This comment has been minimized.

Show comment
Hide comment
@ssw239

ssw239 Oct 3, 2017

Thank you for sharing. This helps me a lot.

ssw239 commented Oct 3, 2017

Thank you for sharing. This helps me a lot.

@kornkaobat

This comment has been minimized.

Show comment
Hide comment
@kornkaobat

kornkaobat Oct 4, 2017

Thank you so much. Without this I couldn't start my README.md professionally.

Thank you so much. Without this I couldn't start my README.md professionally.

@bayramcicek

This comment has been minimized.

Show comment
Hide comment
@bayramcicek

bayramcicek Oct 5, 2017

Thank so much.

bayramcicek commented Oct 5, 2017

Thank so much.

@roo-shy

This comment has been minimized.

Show comment
Hide comment

roo-shy commented Oct 8, 2017

Thanks!

@jloures

This comment has been minimized.

Show comment
Hide comment
@jloures

jloures Oct 11, 2017

Thank you!

jloures commented Oct 11, 2017

Thank you!

@Apophus

This comment has been minimized.

Show comment
Hide comment
@Apophus

Apophus Oct 13, 2017

Awesome!!

Apophus commented Oct 13, 2017

Awesome!!

@TylerJOtte

This comment has been minimized.

Show comment
Hide comment
@TylerJOtte

TylerJOtte Oct 13, 2017

Very clear and helpful; thank you!

Very clear and helpful; thank you!

@ashcode1

This comment has been minimized.

Show comment
Hide comment
@ashcode1

ashcode1 Oct 14, 2017

Great template, thanks for sharing this :)

Great template, thanks for sharing this :)

@Cedric-M

This comment has been minimized.

Show comment
Hide comment
@Cedric-M

Cedric-M Oct 18, 2017

Awesome thank you

Awesome thank you

@rmfranciacastillo

This comment has been minimized.

Show comment
Hide comment
@rmfranciacastillo

rmfranciacastillo Oct 19, 2017

Thanks for sharing this! It's exactly what I needed

Thanks for sharing this! It's exactly what I needed

@nex0ma

This comment has been minimized.

Show comment
Hide comment
@nex0ma

nex0ma Oct 20, 2017

Бпасибки!

nex0ma commented Oct 20, 2017

Бпасибки!

@pavenkostanislav

This comment has been minimized.

Show comment
Hide comment
@pavenkostanislav

pavenkostanislav Oct 24, 2017

Бпасибо

Бпасибо

@sevfitz

This comment has been minimized.

Show comment
Hide comment
@sevfitz

sevfitz Oct 25, 2017

Excellent! Thanks!

sevfitz commented Oct 25, 2017

Excellent! Thanks!

@spencerjpotts

This comment has been minimized.

Show comment
Hide comment

Cheers bud!

@faithcorinne

This comment has been minimized.

Show comment
Hide comment
@faithcorinne

faithcorinne Oct 28, 2017

Awesome! Just what my group needed. Thanks!

Awesome! Just what my group needed. Thanks!

@Jhyeok-lee

This comment has been minimized.

Show comment
Hide comment

Great!

@altcoinrockerxyz

This comment has been minimized.

Show comment
Hide comment

Thank you!

@lifeF

This comment has been minimized.

Show comment
Hide comment
@lifeF

lifeF Nov 6, 2017

thank you!

lifeF commented Nov 6, 2017

thank you!

@Onra

This comment has been minimized.

Show comment
Hide comment
@Onra

Onra Nov 6, 2017

Great ! Thank you :)

Onra commented Nov 6, 2017

Great ! Thank you :)

@karolbledniak

This comment has been minimized.

Show comment
Hide comment
@karolbledniak

karolbledniak Nov 6, 2017

DziΔ™ki! :)

DziΔ™ki! :)

@dbarcosb

This comment has been minimized.

Show comment
Hide comment

dbarcosb commented Nov 9, 2017

Thanks!!

@mariorodeghiero

This comment has been minimized.

Show comment
Hide comment

Thanks !

@AntonioIrizarry

This comment has been minimized.

Show comment
Hide comment

Awesome Stuff

@SivaCse

This comment has been minimized.

Show comment
Hide comment

SivaCse commented Nov 15, 2017

Thanks

@marcyves

This comment has been minimized.

Show comment
Hide comment
@marcyves

marcyves Nov 15, 2017

Thanks, great stuff, very useful

Thanks, great stuff, very useful

@PedroC88

This comment has been minimized.

Show comment
Hide comment
@PedroC88

PedroC88 Nov 16, 2017

Thank you so much!

Thank you so much!

@MagisterSiltar

This comment has been minimized.

Show comment
Hide comment
@MagisterSiltar

MagisterSiltar Nov 16, 2017

A solid template for ReadMes. I would like to add an ENV section.

A solid template for ReadMes. I would like to add an ENV section.

@pass92

This comment has been minimized.

Show comment
Hide comment
@pass92

pass92 Nov 16, 2017

A very good template :)

pass92 commented Nov 16, 2017

A very good template :)

@sputnik63

This comment has been minimized.

Show comment
Hide comment
@sputnik63

sputnik63 Nov 17, 2017

Thanks. Really useful

Thanks. Really useful

@omidnasri

This comment has been minimized.

Show comment
Hide comment

Good one.

@thedaviddias

This comment has been minimized.

Show comment
Hide comment
@mattselkey

This comment has been minimized.

Show comment
Hide comment
@mattselkey

mattselkey Nov 18, 2017

nice, thanks!

nice, thanks!

@tyricec

This comment has been minimized.

Show comment
Hide comment

tyricec commented Nov 19, 2017

Thanks

@zxyle

This comment has been minimized.

Show comment
Hide comment

zxyle commented Nov 20, 2017

Good

@dipta007

This comment has been minimized.

Show comment
Hide comment
@dipta007

dipta007 Nov 22, 2017

Thanks
Awesome one

Thanks
Awesome one

@fonzarely

This comment has been minimized.

Show comment
Hide comment
@fonzarely

fonzarely Nov 24, 2017

Exactly what I needed ! Thanks !

Exactly what I needed ! Thanks !

@Hutnik

This comment has been minimized.

Show comment
Hide comment
@Hutnik

Hutnik Nov 26, 2017

Thank you!

Hutnik commented Nov 26, 2017

Thank you!

@yarivat

This comment has been minimized.

Show comment
Hide comment
@yarivat

yarivat Nov 27, 2017

Thank you!

yarivat commented Nov 27, 2017

Thank you!

@alhorn97

This comment has been minimized.

Show comment
Hide comment
@alhorn97

alhorn97 Nov 27, 2017

Perfect! Thanks.

Perfect! Thanks.

@danielsouzapinna

This comment has been minimized.

Show comment
Hide comment

Thanks!

@nanangTriAndika

This comment has been minimized.

Show comment
Hide comment
@nanangTriAndika

nanangTriAndika Nov 30, 2017

This is great ! Very good explanation. Thank you

This is great ! Very good explanation. Thank you

@RunsWritesCode

This comment has been minimized.

Show comment
Hide comment
@RunsWritesCode

RunsWritesCode Dec 3, 2017

Thanks Billie :)

Thanks Billie :)

@ratan93

This comment has been minimized.

Show comment
Hide comment
@ratan93

ratan93 Dec 5, 2017

Thanks Billie Thompson, it is very helpful.

ratan93 commented Dec 5, 2017

Thanks Billie Thompson, it is very helpful.

@JulienPraud

This comment has been minimized.

Show comment
Hide comment
@JulienPraud

JulienPraud Dec 5, 2017

Great :D Thanks ! πŸ‘

Great :D Thanks ! πŸ‘

@OnebugIS

This comment has been minimized.

Show comment
Hide comment

OnebugIS commented Dec 6, 2017

Thanks!

@Izzur

This comment has been minimized.

Show comment
Hide comment
@Izzur

Izzur Dec 7, 2017

Thanks :) help bootstraping a lot of project in github

Izzur commented Dec 7, 2017

Thanks :) help bootstraping a lot of project in github

@wboswall

This comment has been minimized.

Show comment
Hide comment
@wboswall

wboswall Dec 8, 2017

I like this template a lot. Many thanks. I always have trouble creating one because I don't know what to say.

wboswall commented Dec 8, 2017

I like this template a lot. Many thanks. I always have trouble creating one because I don't know what to say.

@fico7489

This comment has been minimized.

Show comment
Hide comment
@fico7489

fico7489 Dec 9, 2017

Great template!

Does anybody know where I can control SEO meta tags for package home page? I think that title is fetched from here in all cases :

image

But I don't know where the description is fetched? It looks like that GitHub fetch description meta tag randomly from somewhere in readme.MD, my question is if this can be controlled and defined somehow in readme.MD?
I want to define what goes into meta title and meta description and see this in google results.

image

fico7489 commented Dec 9, 2017

Great template!

Does anybody know where I can control SEO meta tags for package home page? I think that title is fetched from here in all cases :

image

But I don't know where the description is fetched? It looks like that GitHub fetch description meta tag randomly from somewhere in readme.MD, my question is if this can be controlled and defined somehow in readme.MD?
I want to define what goes into meta title and meta description and see this in google results.

image

@BillMoriarty

This comment has been minimized.

Show comment
Hide comment

Thank you!

@eerison

This comment has been minimized.

Show comment
Hide comment
@eerison

eerison Dec 11, 2017

Thanks :)

eerison commented Dec 11, 2017

Thanks :)

@adritek

This comment has been minimized.

Show comment
Hide comment
@adritek

adritek Dec 12, 2017

This is fantastic! Thanks!

adritek commented Dec 12, 2017

This is fantastic! Thanks!

@Akanni96

This comment has been minimized.

Show comment
Hide comment
@Akanni96

Akanni96 Dec 12, 2017

Thanks, Great Stuff :)

Thanks, Great Stuff :)

@kazitanvirahsan

This comment has been minimized.

Show comment
Hide comment
@kazitanvirahsan

kazitanvirahsan Dec 14, 2017

Yes. Thank you.

Yes. Thank you.

@ta-riq

This comment has been minimized.

Show comment
Hide comment
@ta-riq

ta-riq Dec 15, 2017

Theres nothing about Alignment , Madam.'

And also Table & Todo Symbol..

Can you add them ?

cause if i create a new one, i'm quite sure no will be able to find that.... cause your Gist is already popular.

Thanks in Advance for this nice Template.

ta-riq commented Dec 15, 2017

Theres nothing about Alignment , Madam.'

And also Table & Todo Symbol..

Can you add them ?

cause if i create a new one, i'm quite sure no will be able to find that.... cause your Gist is already popular.

Thanks in Advance for this nice Template.

@mehulvadodariya2012

This comment has been minimized.

Show comment
Hide comment
@mehulvadodariya2012

mehulvadodariya2012 Dec 15, 2017

Thanks, Great Stuff :)

Thanks, Great Stuff :)

@alexolivet

This comment has been minimized.

Show comment
Hide comment
@alexolivet

alexolivet Dec 16, 2017

Thank you. Great stuff!

Thank you. Great stuff!

@r9software

This comment has been minimized.

Show comment
Hide comment
@r9software

r9software Dec 16, 2017

OMG we all stoled your work, you are awesome! thanks!

OMG we all stoled your work, you are awesome! thanks!

@tandavala

This comment has been minimized.

Show comment
Hide comment
@tandavala

tandavala Dec 18, 2017

This is what i have been looking for. Thanks!

This is what i have been looking for. Thanks!

@CarlBoneri

This comment has been minimized.

Show comment
Hide comment

My man

@Alavi1412

This comment has been minimized.

Show comment
Hide comment
@Alavi1412

Alavi1412 Dec 21, 2017

Thank you, useful

Thank you, useful

@mattestevens

This comment has been minimized.

Show comment
Hide comment
@mattestevens

mattestevens Dec 22, 2017

High level! Thank you!

High level! Thank you!

@felipevamarinho

This comment has been minimized.

Show comment
Hide comment