Title of Your Project
Description of your project
Table of content
Getting Started
Describe how to get started here.
Install
npm install your-project
Usage
Describe how you use it here.
import { configure, useProject } from 'your-project';
configure();
const App = () => {
const [project, setProject] = useProject();
// ... More pseudo code here...
}
Built With
Explain which technologies you've used here.
Contributing
Issues
In the case of a bug report, bugfix or a suggestions, please feel very free to open an issue.
Pull request
Pull requests are always welcome, and I'll do my best to do reviews as fast as I can.
License
This project is licensed under the MIT License
Get Help
- Contact me on my-email@email.com
- If appropriate, open an issue on GitHub
Motivation
Describe your motivation for creating this Open-Source Project
Acknowledgements
Acknowledge the Open-Source projects that you've included in your solution.
See this template in use on the Open-Source project Hue Debugger UI