Skip to content

Commit

Permalink
Add summary of what this add-on does and doesn't do
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
thijzert committed Nov 20, 2024
1 parent 0192fe3 commit 548380f
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions wireguard/DOCS.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 548380f

Please sign in to comment.