docs: make it clear Web RTC Direct is experimental
Henrique Dias committed
Nov 3, 2023 at 14:49 UTC
884a3f36d44e3359f3f5112abb87344cd6d51b49
2 files changed
+4
-2
docs/changelogs/v0.24.md
+2
-2
@@ -10,7 +10,7 @@
10
- [Gateway: the root of the CARs are no longer meaningful](#gateway-the-root-of-the-cars-are-no-longer-meaningful)
11
- [IPNS: improved publishing defaults](#ipns-improved-publishing-defaults)
12
- [IPNS: record TTL is used for caching](#ipns-record-ttl-is-used-for-caching)
13
- - [WebRTC Direct Transport](#webrtc-direct-transport)
13
+ - [Experimental Transport: WebRTC Direct](#experimental-transport-webrtc-direct)
14
- [📝 Changelog](#-changelog)
15
- [👨👩👧👦 Contributors](#-contributors)
16
@@ -69,7 +69,7 @@ DHT, for updates. The TTL value in the IPNS record now serves as a hint for:
69
These changes make it easier for rarely updated IPNS-hosted websites to be
70
cached more efficiently and load faster in browser contexts.
71
72
-#### WebRTC Direct Transport
72
+#### Experimental Transport: WebRTC Direct
73
74
[WebRTC Direct](https://github.com/libp2p/go-libp2p/pull/2337) has now been introduced
75
in [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0) v0.32.0. This
docs/config.md
+2
@@ -2075,6 +2075,8 @@ Type: `flag`
2075
2076
#### `Swarm.Transports.Network.WebRTCDirect`
2077
2078
+**Experimental:** the support for WebRTC Direct is currently experimental.
2079
+
2080
A new feature of [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0)
2081
is the [WebRTC Direct](https://github.com/libp2p/go-libp2p/pull/2337) transport.
2082