Provide a short description explaining the what, why, and how of your project. Use the following questions as a guide:
If your README is long, add a table of contents to make it easy for users to find what they need.
What are the steps required to install your project? Provide a step-by-step description of how to get the development environment running.
Provide instructions and examples for use. Include screenshots as needed.
To add a screenshot, create an assets/images
folder in your repository and upload your screenshot to it. Then, using the relative filepath, add it to your README using the following syntax:
List your collaborators, if any, with links to their GitHub profiles.
If you used any third-party assets that require attribution, list the creators with links to their primary web presence in this section.
If you followed tutorials, include links to those here as well.
Distributed under the MIT License. See LICENSE.txt for more information.