Commit a309f096 authored by vyzo's avatar vyzo
Browse files

Add note to relay docs about internal interface instability

parent 4cb5d00e
......@@ -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`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment