Project Title: Tagline

WTFM, abbreviation: Write The F****ing Manual. Based on the term RTFM. Used when a lack of documentation exists for a given system.

Put a meaningful, short, plain-language description of what this project is trying to accomplish and why it matters. Describe the problem(s) this project solves. Describe how this software can improve the lives of its audience.

Technology stack: Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
Status: Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the CHANGELOG.
Links to production or demo instances
Describe what sets this apart from related-projects. Linking to another doc or page is OK if this can't be expressed in a sentence or two.

Example

Your reader is seeing this first and it's your only chance to convince him/her to keep reading. The example should be minimalistic, preferably a one-liner, 5-10 lines tops. If there is a common Hello World example that comparable projects use to show their approach, this is the place.

Magic magic = new Magic();
magic.applyTo(yourProject);

Features

Important things first
Convenient Spring Boot Auto Configuration
Sensible defaults

Origin

Why does it exist?
Compare/contrast your project with other, similar projects so the user knows how it is different from those projects.

Dependencies

Java 8
Any build tool using Maven Central, or direct download
e.g. Apache HTTP Client

Installation

Selectively add the following dependencies to your project:

Add the following dependency to your project:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>artifact</artifactId>
    <version>${example.version}</version>
</dependency>

Configuration

If the software is configurable, describe it in detail, either here or in other documentation to which you link.

Usage

Show users how to use the software. Be specific. Use appropriate formatting when showing code snippets.

Known issues

Document any known significant shortcomings with the software.

Getting Help

If you have questions, concerns, bug reports, etc., please file an issue in this repository's Issue Tracker.

Getting Involved/Contributing

To contribute, simply make a pull request and add a brief description (1-2 sentences) of your addition or change. For more details, check the contribution guidelines.

Credits and references

Open Issues

list of selected issues
including links

whiskeysierra / WTFM