READ ME FILE TEMPLATE

README-Template.md

Project Title

Short blurb about what your product does.

One Paragraph of project description goes here, there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Table of Contents

• Project Title
  • Getting Started
    • Prerequisites and dependencies
      • Third Party Libraries
    • Build
    • Running
    • Running the tests
    • Break down into end to end tests
    • And coding style tests
  • Deployment
  • API Reference
  • Permissions
  • Versioning
  • Release History
  • Contributors
  • License
  • Acknowledgments

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 and dependencies

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

Give examples

Third Party Libraries

List of all the used libraries and tools

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

Build

A step by step series of examples to build the project.

Give the example

Running

A step by step series of examples that tell you have 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. How to ship a change.

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Permissions

Explain the steps for required permissions to run the project in development environment and production.

Versioning

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

Release History

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Work in progress

Contributors

• Billie Thompson - Initial work - Frontend Team

License

A short snippet describing the license (MIT, Apache, etc.)

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

Acknowledgments

• Hat tip to anyone who's code was used
• Inspiration
• etc