Forked from SimonHoiberg/Open-Source README template
Created
November 23, 2020 06:29
-
-
Save pbteja1998/43824463c5f091bb8d2d4bbbaf24c6f1 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Title of Your Project [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20this%20cool%20project&url=https://github.com/Cool/Project&hashtags=project,opensource) | |
![Github License](https://img.shields.io/badge/license-MIT-green) | |
![Code Coverage](https://img.shields.io/badge/coverage-90%25-green) | |
![React Version](https://img.shields.io/badge/react-v16.12.0-blue.svg) | |
![example](https://mdn.mozillademos.org/files/10529/inspector.png) | |
#### Description of your project | |
## Table of content | |
- [**Getting Started**](#getting-started) | |
- [Built With](#built-with) | |
- [Contributing](#contributing) | |
- [License](#license) | |
- [Get Help](#get-help) | |
- [Motivation](#motivation) | |
- [Acknowledgments](#acknowledgements) | |
## Getting Started | |
Describe how to get started here. | |
### Install | |
```console | |
npm install your-project | |
``` | |
### Usage | |
Describe how you use it here. | |
```javascript | |
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](https://github.com/this/project/blob/master/LICENSE) | |
## Get Help | |
- Contact me on my-email@email.com | |
- If appropriate, [open an issue](https://github.com/this/project/issues) 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](https://github.com/Silind-Software/Hue-Debugger-UI) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment