Skip to content

Commit

Permalink
Added license and updated readme (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickvorgers authored Apr 14, 2024
1 parent 1ae9609 commit 14f0385
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 1 deletion.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contribution guidelines

Contributing to this project should be as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features

## Github is used for everything

Github is used to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase.

1. Fork the repo and create your branch from `main`.
2. If you've changed something, update the documentation.
3. Make sure your code lints (using `scripts/lint`).
4. Test you contribution.
5. Issue that pull request!

## Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](../../issues)

GitHub issues are used to track public bugs.
Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!

## Write bug reports with detail, background, and sample code

**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People *love* thorough bug reports. I'm not even kidding.

## License

By contributing, you agree that your contributions will be licensed under its MIT License.
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 - 2023 Patrick Vorgers [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
-->

[![Issues][issues-shield]][issues-url]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)

![Project Maintenance][maintenance-shield]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

<!-- PROJECT LOGO -->
<br />
Expand Down Expand Up @@ -45,6 +50,7 @@ Import historical energy/water data from external datasources into Home Assistan
<li><a href="#about-the-project">About The Project</a></li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#authors">Authors</a></li>
<li><a href="#contributions">Contributions</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
Expand Down Expand Up @@ -231,7 +237,14 @@ Please share scripts or how-to guides if you have built an integration with a ne

* Patrick Vorgers (the Netherlands)

### All other contributors:
<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- Contributions -->
<a name="contributions"></a>
## Contributions are welcome!

If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
### All contributors:

* Nick de Wijer (https://github.com/ndewijer)
* Initial implementation: GreenChoice
Expand Down Expand Up @@ -266,5 +279,11 @@ Project Link: [https://github.com/patrickvorgers/Home-Assistant-Import-Energy-Da

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[buymecoffee]: https://www.buymeacoffee.com/patrickvorgers
[buymecoffeebadge]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
[commits-shield]: https://img.shields.io/github/commit-activity/y/patrickvorgers/Home-Assistant-Import-Energy-Data.svg?style=for-the-badge
[commits]: https://github.com/patrickvorgers/Home-Assistant-Import-Energy-Data/commits/main
[issues-shield]: https://img.shields.io/github/issues/patrickvorgers/Home-Assistant-Import-Energy-Data.svg?style=for-the-badge
[issues-url]: https://github.com/patrickvorgers/Home-Assistant-Import-Energy-Data/issues
[license-shield]: https://img.shields.io/github/license/patrickvorgers/Home-Assistant-Import-Energy-Data.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-patrickvorgers-blue.svg?style=for-the-badge

0 comments on commit 14f0385

Please sign in to comment.