Outline a brief description of your project. Live demo here.
List the ready features here:
What are the project requirements/dependencies? Where are they listed? A requirements.txt or a Pipfile.lock file perhaps? Where is it located?
Proceed to describe how to install / setup one’s local environment / get started with the project.
How does one go about using it? Provide various use cases and code examples here.
write-your-code-here
Project is: in progress / complete / no longer being worked on. If you are no longer working on it, provide reasons why.
Include areas you believe need improvement / could be improved. Also add TODOs for future development.
Room for improvement:
To do:
Give credit here.
Created by @flynerdpl - feel free to contact me!