Skip to content

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
@RiseUpTogether

This comment has been minimized.

Copy link

@RiseUpTogether RiseUpTogether commented Sep 15, 2016

Thank you

@Villanuevand

This comment has been minimized.

Copy link

@Villanuevand Villanuevand commented Sep 28, 2016

Awesome template!
Thanks ... ๐Ÿ‘

Update:
I made a translated version to spanish from this file.

@GeorgeTaveras1231

This comment has been minimized.

Copy link

@GeorgeTaveras1231 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 PurpleBooth commented Oct 2, 2016

ooh! good catch, fixed ๐Ÿ˜„

@ProElbs

This comment has been minimized.

Copy link

@ProElbs ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !

@justinrains

This comment has been minimized.

Copy link

@justinrains justinrains commented Oct 12, 2016

Thanks!

@LocalMicro

This comment has been minimized.

Copy link

@LocalMicro 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 dtgoitia commented Oct 16, 2016

Clear and complete. Thanks a lot!

@JosefVitu

This comment has been minimized.

Copy link

@JosefVitu 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 PurpleBooth commented Oct 17, 2016

Fixed! Thanks ๐Ÿ˜„

@desfero

This comment has been minimized.

Copy link

@desfero desfero commented Oct 20, 2016

thanks :)

@cancinos

This comment has been minimized.

Copy link

@cancinos cancinos commented Oct 21, 2016

Really nice! Thanks for this guidance!

@surafelml

This comment has been minimized.

Copy link

@surafelml surafelml commented Nov 3, 2016

Thanks!

@f2dmarques

This comment has been minimized.

Copy link

@f2dmarques f2dmarques commented Nov 4, 2016

Excellent template! Thanks!

@rafaelcascalho

This comment has been minimized.

Copy link

@rafaelcascalho rafaelcascalho commented Nov 7, 2016

Helped a lot, thanks ๐Ÿ‘

@andresroberto

This comment has been minimized.

Copy link

@andresroberto andresroberto commented Nov 17, 2016

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

@Sylvainkossi

This comment has been minimized.

Copy link

@Sylvainkossi Sylvainkossi commented Nov 21, 2016

Excellent!

@lamagnotti

This comment has been minimized.

Copy link

@lamagnotti lamagnotti commented Nov 26, 2016

Awesome! Thank you!

@44r0n

This comment has been minimized.

Copy link

@44r0n 44r0n commented Nov 27, 2016

So helpful! Thank you!

@greyfoxamine

This comment has been minimized.

Copy link

@greyfoxamine greyfoxamine commented Dec 5, 2016

oh my GOD thanks a lot

@ShawnBin

This comment has been minimized.

Copy link

@ShawnBin ShawnBin commented Dec 16, 2016

Thank you!

@navkelley

This comment has been minimized.

Copy link

@navkelley navkelley commented Dec 18, 2016

Thank you! This helped me so much.

@afullstopdot

This comment has been minimized.

Copy link

@afullstopdot afullstopdot commented Dec 19, 2016

Thank you so much, really helpful for new developers.

@jmoralesce

This comment has been minimized.

Copy link

@jmoralesce jmoralesce commented Dec 21, 2016

Thank you!

@rahulsingh8

This comment has been minimized.

Copy link

@rahulsingh8 rahulsingh8 commented Dec 27, 2016

Thanks a ton ๐Ÿ‘๐Ÿ‘

@anandprajapati1

This comment has been minimized.

Copy link

@anandprajapati1 anandprajapati1 commented Jan 2, 2017

Very useful. Thanks a lot!

@ctlong

This comment has been minimized.

Copy link

@ctlong ctlong commented Jan 4, 2017

Wonderful, thanks!

@ryan-mooore

This comment has been minimized.

Copy link

@ryan-mooore ryan-mooore commented Jan 5, 2017

Thanks!

@kevinbazira

This comment has been minimized.

Copy link

@kevinbazira kevinbazira commented Jan 11, 2017

Thanks a bunch

@awilliams

This comment has been minimized.

Copy link

@awilliams awilliams commented Jan 13, 2017

Thanks for this

@sicdigital

This comment has been minimized.

Copy link

@sicdigital sicdigital commented Jan 24, 2017

This is really cool. Thanks!

@ldecamp

This comment has been minimized.

Copy link

@ldecamp ldecamp commented Jan 30, 2017

Really cool template. Thanks.

@8eni

This comment has been minimized.

Copy link

@8eni 8eni commented Feb 7, 2017

great template

@dineshraj01

This comment has been minimized.

Copy link

@dineshraj01 dineshraj01 commented Feb 8, 2017

Time saviour! thank you !

@calmjohnson

This comment has been minimized.

Copy link

@calmjohnson calmjohnson commented Feb 12, 2017

Thanks a lot!

@hsjoihs

This comment has been minimized.

Copy link

@hsjoihs hsjoihs commented Feb 13, 2017

Thanks!

@Renato2012

This comment has been minimized.

Copy link

@Renato2012 Renato2012 commented Feb 16, 2017

Thank you!

@christinach

This comment has been minimized.

Copy link

@christinach christinach commented Feb 17, 2017

Thank you! :)

@nirodg

This comment has been minimized.

Copy link

@nirodg nirodg commented Feb 19, 2017

Thank you, nice job!

@divakarsingh

This comment has been minimized.

Copy link

@divakarsingh divakarsingh commented Feb 19, 2017

Good one, provides quick help.

@Borange

This comment has been minimized.

Copy link

@Borange Borange commented Feb 22, 2017

Great job! Thanks!

@reneabreu

This comment has been minimized.

Copy link

@reneabreu reneabreu commented Mar 2, 2017

Thank You! (:

@bnzene

This comment has been minimized.

Copy link

@bnzene bnzene commented Mar 4, 2017

Thank you!

@quintconnect

This comment has been minimized.

Copy link

@quintconnect quintconnect commented Mar 5, 2017

Perfect - thank you!

@JaeDukSeo

This comment has been minimized.

Copy link

@JaeDukSeo JaeDukSeo commented Mar 11, 2017

Thank you!

@willbchang

This comment has been minimized.

Copy link

@willbchang willbchang commented Mar 14, 2017

Thank you!

@crustafari

This comment has been minimized.

Copy link

@crustafari crustafari commented Mar 22, 2017

Thank you!!

@tiagodavi70

This comment has been minimized.

Copy link

@tiagodavi70 tiagodavi70 commented Mar 24, 2017

Thanks man!

@AndreMommert

This comment has been minimized.

Copy link

@AndreMommert AndreMommert commented Mar 26, 2017

Thank you ๐Ÿ‘

@handsfreemc

This comment has been minimized.

Copy link

@handsfreemc handsfreemc commented Mar 28, 2017

Appreciate this greatly!

@mrm8488

This comment has been minimized.

Copy link

@mrm8488 mrm8488 commented Mar 29, 2017

Thanks

@sinamomken

This comment has been minimized.

Copy link

@sinamomken sinamomken commented Mar 29, 2017

How could I fork it to use later?

@pramod1988

This comment has been minimized.

Copy link

@pramod1988 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 sfauch1 commented Mar 29, 2017

Thanks

@guiguiboy

This comment has been minimized.

Copy link

@guiguiboy guiguiboy commented Mar 29, 2017

Thanks !

@daquilino

This comment has been minimized.

Copy link

@daquilino 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 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 Krishna80 commented Apr 4, 2017

thanks a lot nice temp

@Josica

This comment has been minimized.

Copy link

@Josica Josica commented Apr 5, 2017

Thank you!

@mskonline

This comment has been minimized.

Copy link

@mskonline mskonline commented Apr 5, 2017

Thanks...!

@itsonlybarney

This comment has been minimized.

Copy link

@itsonlybarney 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 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 pau-lo commented Apr 6, 2017

Great, thank you.

@joseluizcoe

This comment has been minimized.

Copy link

@joseluizcoe joseluizcoe commented Apr 10, 2017

<3 <3 <3

@spacewasabi

This comment has been minimized.

Copy link

@spacewasabi spacewasabi commented Apr 19, 2017

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

@Kayla425

This comment has been minimized.

Copy link

@Kayla425 Kayla425 commented Apr 19, 2017

Perfect!