Project Title

A brief description of what this project does and who it's for.

Description

An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

• List any prerequisites, libraries, OS version, etc., needed before installing the program.
• e.g., Windows 10, Node.js v12.13.0

Installing

How/where to download your program. Any modifications needed to be made to files/folders.

npm install my-project

Executing program

How to run the program. Step-by-step bullets.

node app.js

Usage

A few motivating and useful examples of how your project can be used. Spice this up with code blocks and potentially more screenshots.

// Use examples
myProject.doSomethingAwesome();

Contributing

Guidelines for how to help with your project.

Code of Conduct

Link to the Code of Conduct.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

Authors

Contributors' names and contact info

• @sith-lords

License

This project is licensed under the [Your License] License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.