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.

Copy link

alehlipka commented Sep 15, 2016

Thank you

@Villanuevand

This comment has been minimized.

Copy link

Villanuevand commented Sep 28, 2016

Awesome template!
Thanks ... ๐Ÿ‘

@GeorgeTaveras1231

This comment has been minimized.

Copy link

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.

Copy link
Owner Author

PurpleBooth commented Oct 2, 2016

ooh! good catch, fixed ๐Ÿ˜„

@ProElbs

This comment has been minimized.

Copy link

ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !

@justinrains

This comment has been minimized.

Copy link

justinrains commented Oct 12, 2016

Thanks!

@LocalMicro

This comment has been minimized.

Copy link

LocalMicro commented Oct 12, 2016

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

@dtgoitia

This comment has been minimized.

Copy link

dtgoitia commented Oct 16, 2016

Clear and complete. Thanks a lot!

@JosefVitu

This comment has been minimized.

Copy link

JosefVitu commented Oct 17, 2016

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites

@PurpleBooth

This comment has been minimized.

Copy link
Owner Author

PurpleBooth commented Oct 17, 2016

Fixed! Thanks ๐Ÿ˜„

@desfero

This comment has been minimized.

Copy link

desfero commented Oct 20, 2016

thanks :)

@cancinos

This comment has been minimized.

Copy link

cancinos commented Oct 21, 2016

Really nice! Thanks for this guidance!

@surafelml

This comment has been minimized.

Copy link

surafelml commented Nov 3, 2016

Thanks!

@f2dmarques

This comment has been minimized.

Copy link

f2dmarques commented Nov 4, 2016

Excellent template! Thanks!

@RCSM

This comment has been minimized.

Copy link

RCSM commented Nov 7, 2016

Helped a lot, thanks ๐Ÿ‘

@andresroberto

This comment has been minimized.

Copy link

andresroberto commented Nov 17, 2016

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

@Sylvainkossi

This comment has been minimized.

Copy link

Sylvainkossi commented Nov 21, 2016

Excellent!

@lamagnotti

This comment has been minimized.

Copy link

lamagnotti commented Nov 26, 2016

Awesome! Thank you!

@44r0n

This comment has been minimized.

Copy link

44r0n commented Nov 27, 2016

So helpful! Thank you!

@greyfoxamine

This comment has been minimized.

Copy link

greyfoxamine commented Dec 5, 2016

oh my GOD thanks a lot

@ShawnBin

This comment has been minimized.

Copy link

ShawnBin commented Dec 16, 2016

Thank you!

@navkelley

This comment has been minimized.

Copy link

navkelley commented Dec 18, 2016

Thank you! This helped me so much.

@afullstopdot

This comment has been minimized.

Copy link

afullstopdot commented Dec 19, 2016

Thank you so much, really helpful for new developers.

@jmoralesce

This comment has been minimized.

Copy link

jmoralesce commented Dec 21, 2016

Thank you!

@rahulsingh8

This comment has been minimized.

Copy link

rahulsingh8 commented Dec 27, 2016

Thanks a ton ๐Ÿ‘๐Ÿ‘

@anandprajapati1

This comment has been minimized.

Copy link

anandprajapati1 commented Jan 2, 2017

Very useful. Thanks a lot!

@ctlong

This comment has been minimized.

Copy link

ctlong commented Jan 4, 2017

Wonderful, thanks!

@ArcodeW

This comment has been minimized.

Copy link

ArcodeW commented Jan 5, 2017

Thanks!

@kevinbazira

This comment has been minimized.

Copy link

kevinbazira commented Jan 11, 2017

Thanks a bunch

@awilliams

This comment has been minimized.

Copy link

awilliams commented Jan 13, 2017

Thanks for this

@sicdigital

This comment has been minimized.

Copy link

sicdigital commented Jan 24, 2017

This is really cool. Thanks!

@ldecamp

This comment has been minimized.

Copy link

ldecamp commented Jan 30, 2017

Really cool template. Thanks.

@8eni

This comment has been minimized.

Copy link

8eni commented Feb 7, 2017

great template

@dineshraj01

This comment has been minimized.

Copy link

dineshraj01 commented Feb 8, 2017

Time saviour! thank you !

@calmjohnson

This comment has been minimized.

Copy link

calmjohnson commented Feb 12, 2017

Thanks a lot!

@hsjoihs

This comment has been minimized.

Copy link

hsjoihs commented Feb 13, 2017

Thanks!

@Renato2012

This comment has been minimized.

Copy link

Renato2012 commented Feb 16, 2017

Thank you!

@christinach

This comment has been minimized.

Copy link

christinach commented Feb 17, 2017

Thank you! :)

@nirodg

This comment has been minimized.

Copy link

nirodg commented Feb 19, 2017

Thank you, nice job!

@divakarsingh

This comment has been minimized.

Copy link

divakarsingh commented Feb 19, 2017

Good one, provides quick help.

@Borange

This comment has been minimized.

Copy link

Borange commented Feb 22, 2017

Great job! Thanks!

@reneabreu

This comment has been minimized.

Copy link

reneabreu commented Mar 2, 2017

Thank You! (:

@bnzene

This comment has been minimized.

Copy link

bnzene commented Mar 4, 2017

Thank you!

@kennorris

This comment has been minimized.

Copy link

kennorris commented Mar 5, 2017

Perfect - thank you!

@JaeDukSeo

This comment has been minimized.

Copy link

JaeDukSeo commented Mar 11, 2017

Thank you!

@WillBChang

This comment has been minimized.

Copy link

WillBChang commented Mar 14, 2017

Thank you!

@crustafari

This comment has been minimized.

Copy link

crustafari commented Mar 22, 2017

Thank you!!

@tiagodavi70

This comment has been minimized.

Copy link

tiagodavi70 commented Mar 24, 2017

Thanks man!

@AndreMommert

This comment has been minimized.

Copy link

AndreMommert commented Mar 26, 2017

Thank you ๐Ÿ‘

@handsfreemc

This comment has been minimized.

Copy link

handsfreemc commented Mar 28, 2017

Appreciate this greatly!

@mrm8488

This comment has been minimized.

Copy link

mrm8488 commented Mar 29, 2017

Thanks

@sinamomken

This comment has been minimized.

Copy link

sinamomken commented Mar 29, 2017

How could I fork it to use later?

@pramod1988

This comment has been minimized.

Copy link

pramod1988 commented Mar 29, 2017

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

@sfauch1

This comment has been minimized.

Copy link

sfauch1 commented Mar 29, 2017

Thanks

@guiguiboy

This comment has been minimized.

Copy link

guiguiboy commented Mar 29, 2017

Thanks !

@daquilino

This comment has been minimized.

Copy link

daquilino commented Mar 31, 2017

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

@LappleApple

This comment has been minimized.

Copy link

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.

Copy link

Krishna80 commented Apr 4, 2017

thanks a lot nice temp

@Josica

This comment has been minimized.

Copy link

Josica commented Apr 5, 2017

Thank you!

@mskonline

This comment has been minimized.

Copy link

mskonline commented Apr 5, 2017

Thanks...!

@itsonlybarney

This comment has been minimized.

Copy link

itsonlybarney commented 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.

@guiguiboy

This comment has been minimized.

Copy link

guiguiboy commented 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?

@pau-lo

This comment has been minimized.

Copy link

pau-lo commented Apr 6, 2017

Great, thank you.

@joseluizcoe

This comment has been minimized.

Copy link

joseluizcoe commented Apr 10, 2017

<3 <3 <3

@SugoiNelson

This comment has been minimized.

Copy link

SugoiNelson commented Apr 19, 2017

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

@Kayla425

This comment has been minimized.

Copy link

Kayla425 commented Apr 19, 2017

Perfect! Thank you.

@sunnydayw

This comment has been minimized.

Copy link

sunnydayw commented Apr 21, 2017

Love it <3

@VisionYi

This comment has been minimized.

Copy link

VisionYi commented Apr 23, 2017

Thank a lot ! Good template.

@KenrySanchez

This comment has been minimized.

Copy link

KenrySanchez commented Apr 23, 2017

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

@PRO2XY

This comment has been minimized.

Copy link

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.

Copy link

KikeVen commented May 6, 2017

Thanks !

@brunobc182

This comment has been minimized.

Copy link

brunobc182 commented May 10, 2017

WoW! Nice, thanks!

@simonpo

This comment has been minimized.

Copy link

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.

Copy link

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.

Copy link

JoseCage commented May 18, 2017

Very useful.. Thanks ๐Ÿ‘

@irinadrozdova

This comment has been minimized.

Copy link

irinadrozdova commented May 19, 2017

Oh! Awesome! Thanks!

@mpruessmeier

This comment has been minimized.

Copy link

mpruessmeier commented May 20, 2017

Thank you, very usefull ๐Ÿ‘

@mhtsharma948

This comment has been minimized.

Copy link

mhtsharma948 commented May 23, 2017

Really useful!!
Thanks!! :)

@kgb1420

This comment has been minimized.

Copy link

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.

Copy link

toni-rmc commented 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?

@Tarptaeya

This comment has been minimized.

Copy link

Tarptaeya commented Jun 5, 2017

Great job to benefit beginners

@burakodabas

This comment has been minimized.

Copy link

burakodabas commented Jun 5, 2017

thank you. good tips for beginners

@willrp

This comment has been minimized.

Copy link

willrp commented Jun 7, 2017

Thanks

@afmguedes

This comment has been minimized.

Copy link

afmguedes commented Jun 12, 2017

Amazing, thanks

@LittaPanda

This comment has been minimized.

Copy link

LittaPanda commented Jun 15, 2017

Thanks a lot! You rocks!

@ub

This comment has been minimized.

Copy link

ub commented Jun 17, 2017

Thank you!

@guruglen

This comment has been minimized.

Copy link

guruglen commented Jun 19, 2017

This is Great. Thanks a lot.

@pankajvasnanitech123

This comment has been minimized.

Copy link

pankajvasnanitech123 commented Jun 20, 2017

Very useful Readme template. Thanks.

@urzolaj

This comment has been minimized.

Copy link

urzolaj commented Jun 21, 2017

Succinct! Exactly what I needed.

@eliasfernandez

This comment has been minimized.

Copy link

eliasfernandez commented Jun 22, 2017

cool. thanks

@ppant

This comment has been minimized.

Copy link

ppant commented Jun 24, 2017

Thanks. Very much needed.

@sid226

This comment has been minimized.

Copy link

sid226 commented Jun 25, 2017

Thanks.

@gavrielCohen

This comment has been minimized.

Copy link

gavrielCohen commented Jun 29, 2017

Thanks :-)

@SalmanTKhan

This comment has been minimized.

Copy link

SalmanTKhan commented Jun 29, 2017

Thanks

@hinell

This comment has been minimized.

Copy link

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.

Copy link

Saki-hanna commented Jul 2, 2017

Thanks

@justinfay

This comment has been minimized.

Copy link

justinfay commented Jul 4, 2017

Thank you.

@kevashcraft

This comment has been minimized.

Copy link

kevashcraft commented Jul 4, 2017

A great template! Thanks ๐Ÿ‘

@randercarlos

This comment has been minimized.

Copy link

randercarlos commented Jul 4, 2017

Very good. Save a lot of time.

@simonmilz

This comment has been minimized.

Copy link

simonmilz commented Jul 11, 2017

Thanks

@simondarke

This comment has been minimized.

Copy link

simondarke commented Jul 12, 2017

Thanks :) Really nice template.

@david95thinkcode

This comment has been minimized.

Copy link

david95thinkcode commented Jul 14, 2017

Very useful. Thank you :)

@mauroao

This comment has been minimized.

Copy link

mauroao commented Jul 19, 2017

Thanks !!!!

@tonyfalabella

This comment has been minimized.

Copy link

tonyfalabella commented Jul 19, 2017

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

@DracarysBZH

This comment has been minimized.

Copy link

DracarysBZH commented Jul 20, 2017

Thank you ! Very nice template !

@RobinTHOREL

This comment has been minimized.

Copy link

RobinTHOREL commented Jul 23, 2017

Thank a lot

@otaruMendez

This comment has been minimized.

Copy link

otaruMendez commented Jul 24, 2017

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

@estand25

This comment has been minimized.

Copy link

estand25 commented Jul 25, 2017

Thank you, this is very helpful

@nvictor

This comment has been minimized.

Copy link

nvictor commented Jul 25, 2017

Thanks!

@TiphaineLAURENT

This comment has been minimized.

Copy link

TiphaineLAURENT commented Jul 26, 2017

Thanks !!

@Chofoteddy

This comment has been minimized.

Copy link

Chofoteddy commented Jul 26, 2017

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

@PascalKu

This comment has been minimized.

Copy link

PascalKu commented Jul 27, 2017

Thank you sooo much! It's awesome!

@jningtho

This comment has been minimized.

Copy link

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.

Copy link

ArnoldGitHub commented Aug 9, 2017

Thank you, it is super useful

@gokulkulkarni1987

This comment has been minimized.

Copy link

gokulkulkarni1987 commented Aug 10, 2017

Thanks a lot, its really helpful

@alireza-nouri

This comment has been minimized.

Copy link

alireza-nouri commented Aug 13, 2017

Thanks a lot

@flakey-bit

This comment has been minimized.

Copy link

flakey-bit commented Aug 14, 2017

Awesome work - thanks a bunch!

@simong33

This comment has been minimized.

Copy link

simong33 commented Aug 15, 2017

Exactly what I was looking for, thanks!

@knapsacklabs

This comment has been minimized.

Copy link

knapsacklabs commented Aug 17, 2017

Thanks

@gmbarroso

This comment has been minimized.

Copy link

gmbarroso commented Aug 18, 2017

Thanks!

@FridaySky

This comment has been minimized.

Copy link

FridaySky commented Aug 19, 2017

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

@vikasFreelancer1913

This comment has been minimized.

Copy link

vikasFreelancer1913 commented 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.

@Osman8a

This comment has been minimized.

Copy link

Osman8a commented Aug 21, 2017

Thank you!!

@belzaaron

This comment has been minimized.

Copy link

belzaaron commented Aug 22, 2017

Good work, Scotty!

@sjgardiner

This comment has been minimized.

Copy link

sjgardiner commented Aug 23, 2017

This is excellent. Many thanks!

@mel-michael

This comment has been minimized.

Copy link

mel-michael commented Aug 28, 2017

This saved me a couple of minutes. Thanks.

@ch08532

This comment has been minimized.

Copy link

ch08532 commented Aug 31, 2017

Thanks! Clean and simple

@settermjd

This comment has been minimized.

Copy link

settermjd commented Sep 4, 2017

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

@ttaratent

This comment has been minimized.

Copy link

ttaratent commented Sep 5, 2017

wonderful! Thanks.

@pravynandas

This comment has been minimized.

Copy link

pravynandas commented Sep 5, 2017

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.

Copy link

gerocha commented Sep 13, 2017

thank you very much

@irakligeek

This comment has been minimized.

Copy link

irakligeek commented Sep 15, 2017

Very useful, thanks!

@AlksAlena

This comment has been minimized.

Copy link

AlksAlena commented Sep 21, 2017

Thank you ! ๐Ÿฅ‡

@3q12

This comment has been minimized.

Copy link

3q12 commented Sep 22, 2017

Thank you

@MashRoofa

This comment has been minimized.

Copy link

MashRoofa commented Sep 22, 2017

Thank you!

@alyssonalvaran

This comment has been minimized.

Copy link

alyssonalvaran commented Sep 26, 2017

Thank you!

@brandonSc

This comment has been minimized.

Copy link

brandonSc commented Sep 27, 2017

Very nice!

@desiraefreedman

This comment has been minimized.

Copy link

desiraefreedman commented Oct 2, 2017

Thank you!

@cynthiayu

This comment has been minimized.

Copy link

cynthiayu commented Oct 2, 2017

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

@ssw239

This comment has been minimized.

Copy link

ssw239 commented Oct 3, 2017

Thank you for sharing. This helps me a lot.

@kornkaobat

This comment has been minimized.

Copy link

kornkaobat commented Oct 4, 2017

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

@bayramcicek

This comment has been minimized.

Copy link

bayramcicek commented Oct 5, 2017

Thank so much.

@roo-shy

This comment has been minimized.

Copy link

roo-shy commented Oct 8, 2017

Thanks!

@jloures

This comment has been minimized.

Copy link

jloures commented Oct 11, 2017

Thank you!

@Apophus

This comment has been minimized.

Copy link

Apophus commented Oct 13, 2017

Awesome!!

@TylerJOtte

This comment has been minimized.

Copy link

TylerJOtte commented Oct 13, 2017

Very clear and helpful; thank you!

@ashcode1

This comment has been minimized.

Copy link

ashcode1 commented Oct 14, 2017

Great template, thanks for sharing this :)

@Cedric-M

This comment has been minimized.

Copy link

Cedric-M commented Oct 18, 2017

Awesome thank you

@rmfranciacastillo

This comment has been minimized.

Copy link

rmfranciacastillo commented Oct 19, 2017

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

@nex0ma

This comment has been minimized.

Copy link

nex0ma commented Oct 20, 2017

ะกะฟะฐัะธะฑะบะธ!

@pavenkostanislav

This comment has been minimized.

Copy link

pavenkostanislav commented Oct 24, 2017

ะกะฟะฐัะธะฑะพ

@sevfitz

This comment has been minimized.

Copy link

sevfitz commented Oct 25, 2017

Excellent! Thanks!

@spencerjpotts

This comment has been minimized.

Copy link

spencerjpotts commented Oct 27, 2017

Cheers bud!

@faithcorinne

This comment has been minimized.

Copy link

faithcorinne commented Oct 28, 2017

Awesome! Just what my group needed. Thanks!

@Jhyeok-lee

This comment has been minimized.

Copy link

Jhyeok-lee commented Nov 3, 2017

Great!

@altcoinrockerxyz

This comment has been minimized.

Copy link

altcoinrockerxyz commented Nov 4, 2017

Thank you!

@lifeF

This comment has been minimized.

Copy link

lifeF commented Nov 6, 2017

thank you!

@Onra

This comment has been minimized.

Copy link

Onra commented Nov 6, 2017

Great ! Thank you :)

@karolbledniak

This comment has been minimized.

Copy link

karolbledniak commented Nov 6, 2017

Dziฤ™ki! :)

@dbarcosb

This comment has been minimized.

Copy link

dbarcosb commented Nov 9, 2017

Thanks!!

@mariorodeghiero

This comment has been minimized.

Copy link

mariorodeghiero commented Nov 14, 2017

Thanks !

@AntonioIrizarry

This comment has been minimized.

Copy link

AntonioIrizarry commented Nov 14, 2017

Awesome Stuff

@SivaCse

This comment has been minimized.

Copy link

SivaCse commented Nov 15, 2017

Thanks

@marcyves

This comment has been minimized.

Copy link

marcyves commented Nov 15, 2017

Thanks, great stuff, very useful

@PedroC88

This comment has been minimized.

Copy link

PedroC88 commented Nov 16, 2017

Thank you so much!

@MagisterSiltar

This comment has been minimized.

Copy link

MagisterSiltar commented Nov 16, 2017

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

@pass92

This comment has been minimized.

Copy link

pass92 commented Nov 16, 2017

A very good template :)

@sputnik63

This comment has been minimized.

Copy link

sputnik63 commented Nov 17, 2017

Thanks. Really useful

@omidnasri

This comment has been minimized.

Copy link

omidnasri commented Nov 17, 2017

Good one.

@thedaviddias

This comment has been minimized.

Copy link

thedaviddias commented Nov 18, 2017

Thanks @PurpleBooth!

@mattselkey

This comment has been minimized.

Copy link

mattselkey commented Nov 18, 2017

nice, thanks!

@tyricec

This comment has been minimized.

Copy link

tyricec commented Nov 19, 2017

Thanks

@zxyle

This comment has been minimized.

Copy link

zxyle commented Nov 20, 2017

Good

@dipta007

This comment has been minimized.

Copy link

dipta007 commented Nov 22, 2017

Thanks
Awesome one

@fonzarely

This comment has been minimized.

Copy link

fonzarely commented Nov 24, 2017

Exactly what I needed ! Thanks !

@Hutnik

This comment has been minimized.

Copy link

Hutnik commented Nov 26, 2017

Thank you!

@yarivat

This comment has been minimized.

Copy link

yarivat commented Nov 27, 2017

Thank you!

@alhorn97

This comment has been minimized.

Copy link

alhorn97 commented Nov 27, 2017

Perfect! Thanks.

@danielsouzapinna

This comment has been minimized.

Copy link

danielsouzapinna commented Nov 28, 2017

Thanks!

@nanangTriAndika

This comment has been minimized.

Copy link

nanangTriAndika commented Nov 30, 2017

This is great ! Very good explanation. Thank you

@RunsWritesCode

This comment has been minimized.

Copy link

RunsWritesCode commented Dec 3, 2017

Thanks Billie :)

@ratan93

This comment has been minimized.

Copy link

ratan93 commented Dec 5, 2017

Thanks Billie Thompson, it is very helpful.

@JulienPraud

This comment has been minimized.

Copy link

JulienPraud commented Dec 5, 2017

Great :D Thanks ! ๐Ÿ‘

@OnebugIS

This comment has been minimized.

Copy link

OnebugIS commented Dec 6, 2017

Thanks!

@Izzur

This comment has been minimized.

Copy link

Izzur commented Dec 7, 2017

Thanks :) help bootstraping a lot of project in github

@wboswall

This comment has been minimized.

Copy link

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.

Copy link

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.

Copy link

BillMoriarty commented Dec 11, 2017

Thank you!

@eerison

This comment has been minimized.

Copy link

eerison commented Dec 11, 2017

Thanks :)

@adritek

This comment has been minimized.

Copy link

adritek commented Dec 12, 2017

This is fantastic! Thanks!

@Akanni96

This comment has been minimized.

Copy link

Akanni96 commented Dec 12, 2017

Thanks, Great Stuff :)

@kazitanvirahsan

This comment has been minimized.

Copy link

kazitanvirahsan commented Dec 14, 2017

Yes. Thank you.

@ta-riq

This comment has been minimized.

Copy link

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.

Copy link

mehulvadodariya2012 commented Dec 15, 2017

Thanks, Great Stuff :)

@alexolivet

This comment has been minimized.

Copy link

alexolivet commented Dec 16, 2017

Thank you. Great stuff!

@r9software

This comment has been minimized.

Copy link

r9software commented Dec 16, 2017

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

@tandavala

This comment has been minimized.

Copy link

tandavala commented Dec 18, 2017

This is what i have been looking for. Thanks!

@CarlBoneri

This comment has been minimized.

Copy link

CarlBoneri commented Dec 21, 2017

My man

@Alavi1412

This comment has been minimized.

Copy link

Alavi1412 commented Dec 21, 2017

Thank you, useful

@mattestevens

This comment has been minimized.

Copy link

mattestevens commented Dec 22, 2017

High level! Thank you!

@felipevamarinho

This comment has been minimized.

Copy link

felipevamarinho commented Dec 23, 2017

Thank you!

@mgrc45

This comment has been minimized.

Copy link

mgrc45 commented Dec 25, 2017

Thank you!

@PillPall

This comment has been minimized.

Copy link

PillPall commented Dec 27, 2017

Thanks!

@zhjgithub

This comment has been minimized.

Copy link

zhjgithub commented Dec 30, 2017

Excellent!

@octagonal

This comment has been minimized.

Copy link

octagonal commented Jan 2, 2018

Thanks!

@Frans-Willem

This comment has been minimized.

Copy link

Frans-Willem commented Jan 7, 2018

Thank you :)

@foxbit19

This comment has been minimized.

Copy link

foxbit19 commented Jan 8, 2018

Very useful! Thank you!

@mbe14

This comment has been minimized.

Copy link

mbe14 commented Jan 9, 2018

Thank you for this useful template!

@emreberber

This comment has been minimized.

Copy link

emreberber commented Jan 12, 2018

Tnx ๐Ÿ’ฏ

@tusharkumawat

This comment has been minimized.

Copy link

tusharkumawat commented Jan 12, 2018

thanks

@praXin

This comment has been minimized.

Copy link

praXin commented Jan 15, 2018

Great template. Thank you for sharing!

@jcsunderland

This comment has been minimized.

Copy link

jcsunderland commented Jan 15, 2018

Very useful, thanks!

@fernandorovai

This comment has been minimized.

Copy link

fernandorovai commented Jan 17, 2018

Great! Thank you!

@mmansion

This comment has been minimized.

Copy link

mmansion commented Jan 17, 2018

Good stuff. Thanks!

@RonKG

This comment has been minimized.

Copy link

RonKG commented Jan 18, 2018

Very helpful. Thank you for taking the time to share!

@jeetshah26

This comment has been minimized.

Copy link

jeetshah26 commented Jan 18, 2018

Great Resource

@joladubu

This comment has been minimized.

Copy link

joladubu commented Jan 22, 2018

Thanks a bunch!

@WandileChamane

This comment has been minimized.

Copy link

WandileChamane commented Jan 22, 2018

Thanks!

@cjoushua

This comment has been minimized.

Copy link

cjoushua commented Jan 23, 2018

Awesome template

Thank you!

@shoxtrem

This comment has been minimized.

Copy link

shoxtrem commented Jan 25, 2018

Thank you for this amazing template! Starred ๐Ÿ‘ ๐Ÿ˜„

@planbsim

This comment has been minimized.

Copy link

planbsim commented Jan 25, 2018

Thank you!

@ghost

This comment has been minimized.

Copy link

ghost commented Jan 28, 2018

Thank you! Very helpful template! :D

@WiseWillian

This comment has been minimized.

Copy link

WiseWillian commented Feb 1, 2018

Amazing!

@yoX64

This comment has been minimized.

Copy link

yoX64 commented Feb 2, 2018

Thank you!

@Dillonjay

This comment has been minimized.

Copy link

Dillonjay commented Feb 3, 2018

You tha bomb! Thanks =)

@SideMasterGM

This comment has been minimized.

Copy link

SideMasterGM commented Feb 5, 2018

Thank you partners.

@rlclaro

This comment has been minimized.

Copy link

rlclaro commented Feb 6, 2018

Very useful! Thank you!

@BruceTheTech

This comment has been minimized.

Copy link

BruceTheTech commented Feb 7, 2018

Thanks. This is exactly what I need to get started. I love templates. Makes life easy.

@lechugalf

This comment has been minimized.

Copy link

lechugalf commented Feb 8, 2018

Awesome! Thank you!

@Netrhil

This comment has been minimized.

Copy link

Netrhil commented Feb 9, 2018

Thank you!!! <3

@WaximeA

This comment has been minimized.

Copy link

WaximeA commented Feb 9, 2018

Nice thanks

@jstuart3

This comment has been minimized.

Copy link

jstuart3 commented Feb 10, 2018

Wow, this is so amazing! So clear and thorough. Thanks a lot for posting this.

@ms-vague

This comment has been minimized.

Copy link

ms-vague commented Feb 12, 2018

Many thanks!

@shsagari

This comment has been minimized.

Copy link

shsagari commented Feb 12, 2018

Thanks! Very good tutorial!

@osieltorres

This comment has been minimized.

Copy link

osieltorres commented Feb 19, 2018

Thanks, best template for README.

@glafer

This comment has been minimized.

Copy link

glafer commented Feb 20, 2018

Thanks! :)

@anule

This comment has been minimized.

Copy link

anule commented Feb 20, 2018

this is awesome! thanks for sharing :)

@alirezarpi

This comment has been minimized.

Copy link

alirezarpi commented Feb 21, 2018

Helpful af ... <3

@pepe-romeros

This comment has been minimized.

Copy link

pepe-romeros commented Feb 22, 2018

Thanks!

@cowboycb

This comment has been minimized.

Copy link

cowboycb commented Feb 22, 2018

Thanks for sharing this template

@wsp50317

This comment has been minimized.

Copy link

wsp50317 commented Feb 22, 2018

Thanks!

@jamesvanleuven

This comment has been minimized.

Copy link

jamesvanleuven commented Feb 25, 2018

awesome! thnx for saving the coder world time :)

@haunterck

This comment has been minimized.

Copy link

haunterck commented Feb 27, 2018

Thanks!, helpful template

@mkessler

This comment has been minimized.

Copy link

mkessler commented Feb 28, 2018

Thanks!

@marekbruchaty

This comment has been minimized.

Copy link

marekbruchaty commented Mar 1, 2018

Awesome! :)

@avcconti

This comment has been minimized.

Copy link

avcconti commented Mar 2, 2018

Thanks man, this is going to be my first readme file.

@JLansey

This comment has been minimized.

Copy link

JLansey commented Mar 2, 2018

Thank you nice work!

@recursioner

This comment has been minimized.

Copy link

recursioner commented Mar 5, 2018

Great Job, thanks .

@yeongseon

This comment has been minimized.

Copy link

yeongseon commented Mar 6, 2018

Thanks.

@rogeralbinoi

This comment has been minimized.

Copy link

rogeralbinoi commented Mar 6, 2018

Thanks! ;)

@EgorChe

This comment has been minimized.

Copy link

EgorChe commented Mar 7, 2018

Thanks!

@renatoassis01

This comment has been minimized.

Copy link

renatoassis01 commented Mar 7, 2018

Tranks!

@jfp315

This comment has been minimized.

Copy link

jfp315 commented Mar 7, 2018

Fantastic template. Thank you for your work.

@macalac

This comment has been minimized.

Copy link

macalac commented Mar 8, 2018

Just what I was looking for! Thanks!

@rohsyl

This comment has been minimized.

Copy link

rohsyl commented Mar 8, 2018

thx mvp !

@eduardohenrik

This comment has been minimized.

Copy link

eduardohenrik commented Mar 8, 2018

Muito obrigado! Thanks.

@dwisetiyadi

This comment has been minimized.

Copy link

dwisetiyadi commented Mar 12, 2018

Many thanks..

@brentongarrett0