Note Your documentation is a direct reflection of your software, so hold it to the same standards.
See more README TEMPLATE HERE
A paragraph explaining your work, who you are, and why you made it.
Mention who you are and link to your GitHub or organization's website.
Show off what your software looks like in action! Try to limit it to one-liners if possible and don't delve into API specifics.
Simple, understandable installation instructions!
git clone <clone_url>
cd <repo_name>
npm installThis project welcomes contributions and suggestions. Please see the CONTRIBUTING.md for more information.
The scripts and documentation in this project are released under the YOUR_LICENSE
Find out more about how to reach us at your_contact