Skip to content

Instantly share code, notes, and snippets.

Last active December 6, 2023 11:42
Star You must be signed in to star a gist
What would you like to do?
A template to make good

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.


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

Give examples


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


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


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


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


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


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


  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
Copy link

There are many templates out there. I found your's the simplest. This is the most to the point template without any flashy badges.

Copy link

Great Job! Thank you so much!

Copy link

Great Readme, Thanks.

Copy link

Perfect :)

Copy link

Outstanding Thanks!
It didn't just give me how to write down the README but also give me enlightening what I even don't know about my projects need.

Copy link

rodaw92 commented Jul 2, 2022

Amazing, Thank you

Copy link

rami-HP commented Jul 6, 2022

Thank you 👍

Copy link

ilovecopy commented Jul 18, 2022

If I have a screenshot or picture about my project,Which paragraph should I put the picture in the readme?

Copy link

Thank you! About to use that template.

Copy link

Great job! Thanks a lot!

Copy link


Copy link

Thanks 😊

Copy link

Thanks you search me a my way so very very Thanks

Copy link

sdn0303 commented Oct 4, 2022

Great job! thank you so much 🙏

Copy link

Thanks! Great job!

Copy link

thanks !

Copy link

Thanks a bunch ! This is exactly what i was looking for.

Copy link

thank you great work

Copy link

Payment is not received please help me

Copy link

Londino commented Feb 17, 2023

Payment is not received please help me


Copy link

thank you great work!

Copy link

Good job!

Copy link


Copy link

How to make its look like that? I mean, mine, I can see only raw. inside apiary.apid file

Copy link

wanted to make like yours.

Copy link

Un gran logro pa

Copy link

warsab commented Jul 11, 2023


Copy link

Manavv20 commented Aug 7, 2023

Very Useful

Copy link


Copy link

Thanks, that’s exactly what I’ve been searching for! 🙌

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