Skip to content

Instantly share code, notes, and snippets.

@dylan-k

dylan-k/README-Template.md

Forked from PurpleBooth/README-Template.md
Last active April 1, 2022 13:37
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save dylan-k/722cbe95f65184283b084c9330b4e063 to your computer and use it in GitHub Desktop.
Save dylan-k/722cbe95f65184283b084c9330b4e063 to your computer and use it in GitHub Desktop.
Download ZIP
Template for README file
Raw
README-Template.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.

Prerequisites

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

Give examples

Installing

  • A step by step
  • series of example commands
  • how to get it running

End with an example of how to confirm it's installed correctly

Usage

For each feature/function of the project, list the feature, describe what it does, and demonstrate how to do it.

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment