Here goes your awesome project description!
Add more general information about project. What the purpose of the project is? Motivation? Put possible docs / coda link here.
- Tech 1 - version 1.0
- Tech 2 - version 2.0
- Tech 3 - version 3.0
Describe how to install / setup your local environement / add link to demo version.
If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Show examples of usage:
put-your-code-here
List of features ready and TODOs for future development
- Awesome feature 1
- Awesome feature 2
- Awesome feature 3
To-do list:
- Wow improvement to be done 1
- Wow improvement to be done 2
Project is: in progress, finished, no longer continue and why?
State if you are open to contributions and what your requirements are for accepting them.
Add here credits. Project inspired by..., based on...
Created by @vulpineblaze - feel free to contact me!