Repo or Product Name

A brief description of what the repo contains

Getting Started

Instructions for using the repo. May also include details on how to configure development environments or any other useful information for people that are new to the repo.

Prerequisites

• A list of the tools and information required to use the repo

Installing

1. An ordered list with simple instructions for installing the stuff in the repo

CI/CD

Details of how the repo is deployed, and where the pipeline (fingers crossed) lives

Deployment steps

(Optional header if multiple deployment methods exist - repeat as needed)

1. An ordered list of the steps to deploy the stuff in the repo

Architecture

A description of the design of what is contained in the repo. Diagrams are optional, but preferable. Provide as much detail as possible.

Process Diagram (if applicable)

1. An ordered list of how processes flow within the system defined by the repo

Built With

• A list of the technologies used by the project

Contributing

Please read the contribution guidelines for details on our standards, and the process for submitting pull requests.

Support

For information on getting help or support with this project, please read the support guide

Versioning

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

Authors

• A list of the main authors who have contributed to the project (probably the owners)

See also the list of contributors who participated in this project.

Acknowledgments

• A list of any reference material that might help in understanding the stuff in the repo. This might contain blog posts, reference architectures, or other repos.