From 759fb7c3d591ec582a4ce0c750dcba5e947249d6 Mon Sep 17 00:00:00 2001 From: moritzruth Date: Tue, 9 Jul 2024 23:13:54 +0200 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bd986c4..dfdf663 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,13 @@ It connects to your [MQTT broker](https://www.home-assistant.io/integrations/mqtt/) and registers a simple _Wake-on-LAN_ button for every specified host. +Note that [Home Assistant also has native support for Wake-on-LAN](https://www.home-assistant.io/integrations/wake_on_lan/). +This project is useful for when you don’t want your Home Assistant container to use host networking or when the device to be woken up is in an entirely different network. + + ## Usage -This tool is intended to be used as a companion container to the Home Assistant container. +This tool is intended to be used as a companion to the Home Assistant container. Your `docker-compose.yml` may look like this: @@ -52,9 +56,11 @@ mac_address = "20:5D:48:98:94:C0" # ms_between_packets = 500 ``` + ## License -hass-wol is licensed under the [Blue Oak Model License 1.0.0](./LICENSE.md). +This project is available under the permissive [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0). + ## Related projects