Project name is a <utility/tool/feature> that allows <insert_target_audience> to do <action/task_it_does>.

Additional line of information text about what the project does. Your introduction should be around 2 or 3 sentences. Don't go overboard, people won't read it.

Basic diagram outline the architecture of the project and it's service dependencies, should there be any.

(you can use the mermaidjs website for this)

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of <coding_language/dependency/requirement_1>
• You have a <Linux/Mac> machine. State which OS is supported/which is not.
• You have read <guide/link/documentation_related_to_project>.

To install <project_name>, follow these steps:

Linux and macOS:

<install_command>

To use <project_name>, follow these steps:

<usage_example>

Add run commands and examples you think users will find useful. Provide an options reference for bonus points!

To contribute to <project_name>, follow these steps:

1. Clone this repository.
2. Create a feature branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request against develop.

If you want to contact someone about this specific project please refer to the following channel: #eng_...