From 016a366d0ff8b728992700c8fadc3c955d98c0cc Mon Sep 17 00:00:00 2001 From: Jordan Whited Date: Tue, 29 Dec 2020 13:22:25 -0800 Subject: [PATCH] Update README for consistent name/target format --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 38f90b1..3dea25f 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ wgsd ZONE DEVICE ## Querying -Following RFC6763 this plugin provides a listing of peers via PTR records at the namespace `_wireguard._udp.`. The target for the PTR records is `._wireguard._udp.` which corresponds to SRV records. SRV targets are of the format `.`. When querying the SRV record for a peer, the target A/AAAA records will be included in the "additional" section of the response. Public keys are represented in Base32 rather than Base64 to allow for their use in node names where they are treated as case-insensitive by the DNS. +Following RFC6763 this plugin provides a listing of peers via PTR records at the namespace `_wireguard._udp.`. The target for the PTR records is of the format `._wireguard._udp.`. This same format is used for the accompanying SRV and A/AAAA records. When querying the SRV record for a peer, the target A/AAAA records will be included in the "additional" section of the response. Public keys are represented in Base32 rather than Base64 to allow for their use in node names where they are treated as case-insensitive by the DNS. ## Example @@ -93,4 +93,4 @@ syKB97XhGnvC+kynh2KqQJPXoOoOpx/HmpMRTc+r4js= ## TODOs - [x] unit tests - [ ] SOA record support -- [x] CI & release binaries \ No newline at end of file +- [x] CI & release binaries