From a89e81625b51c75916017ee204bd63b45608a9b6 Mon Sep 17 00:00:00 2001 From: Stefan Allius Date: Mon, 25 Sep 2023 23:15:12 +0200 Subject: [PATCH] contribution added --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c389d1e..a495abc 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ By means of `docker` a simple installation and operation is possible. By using ` ❗An essential requirement is that the proxy can be looped into the connection between the inverter and TSUN Cloud. -There are various ways to do this, for example via DNS host entry or via firewall +There are various ways to do this, for example via an DNS host entry or via firewall rules (iptables) in your router. However, depending on the circumstances, not all of them are possible. -If you use a PiHole, you can also store the host entry in the PiHole. +If you use a Pi-hole, you can also store the host entry in the Pi-hole. ``` ## Features @@ -61,6 +61,10 @@ Note the aiomqtt library used is based on the paho-mqtt library, which has a dua This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Breaking changes will only occur in major `X.0.0` releases. +## Contributing + +We're very happy to receive contributions to this project! You can get started by reading [CONTRIBUTING.md](https://github.com/s-allius/tsun-gen3-proxy/blob/main/CONTRIBUTING.md). + ## Changelog The changelog lives in [CHANGELOG.md](https://github.com/s-allius/tsun-gen3-proxy/blob/main/CHANGELOG.md). It follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).