From c07d438d98f781a0c552a7b8b3194e0179fecf1c Mon Sep 17 00:00:00 2001 From: Andre Basche Date: Tue, 17 Oct 2023 18:17:33 +0200 Subject: [PATCH] Update readme for #1 --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c7a5051..8420641 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# Speedport Integration for Home Assistant +# Speedport Integration for Home Assistant + [![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://hacs.xyz) [![GitHub](https://img.shields.io/github/license/Andre0512/speedport?color=red)](https://github.com/Andre0512/speedport/blob/main/LICENSE) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/Andre0512/speedport?color=green)](https://github.com/Andre0512/speedport/releases/latest) [![GitHub all releases](https://img.shields.io/github/downloads/Andre0512/speedport/total?color=blue&label=total%20downloads)](https://tooomm.github.io/github-release-stats/?username=Andre0512&repository=speedport) -Telekom Speedport Integration for Home Assistant based on [speedport-api](https://github.com/Andre0512/speedport-api.git). +Telekom Speedport Integration for Home Assistant based +on [speedport-api](https://github.com/Andre0512/speedport-api.git). ## Features @@ -13,25 +15,22 @@ Telekom Speedport Integration for Home Assistant based on [speedport-api](https: - Reconnect, reboot, wps on - Sensors (IP-Addresses, Upload/Download, Connection, ...) - ## Supported devices + * Speedport Smart 3 * Speedport Smart 4 - ## Installation -_Currently [waiting for acceptance](https://github.com/hacs/default/pull/2096) into hacs default repo..._ + +_Currently [waiting for acceptance](https://github.com/hacs/default/pull/2096) to hacs default repo..._ + #### Installing via HACS (Custom) + 1. You need to have installed [HACS](https://hacs.xyz/) 2. Go to HACS -> Integrations 3. Add this repo (`https://github.com/Andre0512/speedport.git`) into your HACS custom repositories 4. Search for Speedport and download it 5. Restart your Home Assistant -6. Go to Settings -> Devices & Services -7. Shift reload your browser -8. Click Add Integration -9. Search for Speedport -10. Insert your router IP/hostname and your password ## Configuration @@ -40,8 +39,13 @@ _Currently [waiting for acceptance](https://github.com/hacs/default/pull/2096) i **Method 2**: Settings > Devices & Services > Add Integration > **Speedport** _If the integration is not in the list, you need to clear the browser cache._ +### Further Information + +If you have email notifications enabled, make sure you have the "A security related event has occurred" option unchecked +or you will receive a lot of emails, see [#1](https://github.com/Andre0512/speedport/issues/1). ## Support + If you find this project helpful and would like to support its development, you can buy me a coffee! ☕ [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/andre0512)