One Paragraph of project description goes here.

Example: This is a template for all READMEs in Thryft. It is not meant to replace in-depth documentation. Rather, it serves to give the user a quick 1 page overview about the entire repo. Of particular importance is the Routes section. As the endpoints will likely be used extensively, it is imperative to document the behaviour of the endpoints as accurately as possible.

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

Document the exposed endpoints and its status codes.

Give instructions on how to generate documentation.

Tell the user where to find in-depth documentation.

Explain how to run the automated tests for this system

Explain what these tests test and why

Give an example

Explain what these tests test and why

Give an example

Add additional notes about how to deploy this on a live system

Examples:

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

Optional.

Optional.

Example:

• Ye Kai - Initial work - mrnewguy
• Bernard - Version 2 - bernardboey

Optional.

Optional.