Add note to relay docs about internal interface instability

libp2p · Nov 6, 2018 · a309f09 · a309f09
1 parent 4cb5d00
commit a309f09
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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`