From 548380fcd6357ce95de593b38693b26fa44c3d9b Mon Sep 17 00:00:00 2001 From: Thijs van Dijk <845572+thijzert@users.noreply.github.com> Date: Thu, 30 May 2024 18:07:07 +0200 Subject: [PATCH] Add summary of what this add-on does and doesn't do This commit moves some general WireGuard promo copy to its own heading, and adds a short summary of the add-on capabilities to the top of the documentation page. --- wireguard/DOCS.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/wireguard/DOCS.md b/wireguard/DOCS.md index 75fd37b..6d8a8d2 100644 --- a/wireguard/DOCS.md +++ b/wireguard/DOCS.md @@ -1,8 +1,16 @@ # Home Assistant Community Add-on: WireGuard [WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that -utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, -and more useful than IPsec, while avoiding the massive headache. +utilizes state-of-the-art cryptography. This add-on allows you to use your +Home Assistant add-on as a bridge server, and easily configure and connect +client devices. + +**Note**: installing this add-on does not expose the HA interface to connected +WireGuard peers. + +## About WireGuard +WireGuard aims to be faster, simpler, leaner, and more useful than IPsec, +while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general-purpose VPN for running on embedded interfaces and