From a309f096067c578402a4fdaec133160a9abb1351 Mon Sep 17 00:00:00 2001 From: vyzo Date: Tue, 6 Nov 2018 09:50:25 +0200 Subject: [PATCH] Add note to relay docs about internal interface instability --- p2p/host/relay/doc.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/p2p/host/relay/doc.go b/p2p/host/relay/doc.go index 8e642b2..c0a5878 100644 --- a/p2p/host/relay/doc.go +++ b/p2p/host/relay/doc.go @@ -3,6 +3,8 @@ The relay package contains host implementations that automatically advertise relay addresses when the presence of NAT is detected. This feature is dubbed `autorelay`. +Warning: the internal interfaces are unstable. + System Components: - AutoNATService instances -- see https://github.com/libp2p/go-libp2p-autonat-svc - One or more relays, instances of `RelayHost` -- GitLab