Docker Readme & Description Template

For projects that publish containers.

Container Name

A short description of the container. What is this for, who is this for, why should someone continue to read this README.

Install and Setup

List any prerequisities, setup options and configuation details.

• Install Docker on your machine.
• Then, either run the pre-built image we’ve provided on Docker Hub, or build the image yourself from the source code.
• This container was tested on 18.09.1 (for example)

Usage

List all parameters.

Working Together

Include information such as:

• Where to Get Help
• Where to File Issues
• Image Updates
• Maintained By

License Information

This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.

As with all Docker images, these may contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained). It is the image user’s responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

---