Skip to content

Commit

Permalink
docs: make it clear Web RTC Direct is experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
hacdias committed Nov 3, 2023
1 parent 9f3251c commit 884a3f3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/changelogs/v0.24.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 884a3f3

Please sign in to comment.