From 884a3f36d44e3359f3f5112abb87344cd6d51b49 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Fri, 3 Nov 2023 14:49:35 +0100 Subject: [PATCH] docs: make it clear Web RTC Direct is experimental --- docs/changelogs/v0.24.md | 4 ++-- docs/config.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/changelogs/v0.24.md b/docs/changelogs/v0.24.md index 1a80e3437..34a8490b0 100644 --- a/docs/changelogs/v0.24.md +++ b/docs/changelogs/v0.24.md @@ -10,7 +10,7 @@ - [Gateway: the root of the CARs are no longer meaningful](#gateway-the-root-of-the-cars-are-no-longer-meaningful) - [IPNS: improved publishing defaults](#ipns-improved-publishing-defaults) - [IPNS: record TTL is used for caching](#ipns-record-ttl-is-used-for-caching) - - [WebRTC Direct Transport](#webrtc-direct-transport) + - [Experimental Transport: WebRTC Direct](#experimental-transport-webrtc-direct) - [๐Ÿ“ Changelog](#-changelog) - [๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Contributors](#-contributors) @@ -69,7 +69,7 @@ DHT, for updates. The TTL value in the IPNS record now serves as a hint for: These changes make it easier for rarely updated IPNS-hosted websites to be cached more efficiently and load faster in browser contexts. -#### WebRTC Direct Transport +#### Experimental Transport: WebRTC Direct [WebRTC Direct](https://github.com/libp2p/go-libp2p/pull/2337) has now been introduced in [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0) v0.32.0. This diff --git a/docs/config.md b/docs/config.md index 1280ec9f4..1c8b0ed86 100644 --- a/docs/config.md +++ b/docs/config.md @@ -2075,6 +2075,8 @@ Type: `flag` #### `Swarm.Transports.Network.WebRTCDirect` +**Experimental:** the support for WebRTC Direct is currently experimental. + A new feature of [`go-libp2p`](https://github.com/libp2p/go-libp2p/releases/tag/v0.32.0) is the [WebRTC Direct](https://github.com/libp2p/go-libp2p/pull/2337) transport.