diff --git a/README.md b/README.md index efe10ee..6487774 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,17 @@ Some of the cool and cutting-edge [transport protocols](https://connectivity.lib - WebTransport - WebRTC +- WebRTC-direct - QUIC - TCP ## Packages -| Packge | Description | WebTransport | WebRTC | QUIC | TCP | -|:--------------------------------| :----------------------------------------------- | ------------ | ------ | ---- | --- | -| [`js-peer`](./js-peer/) | Next.js based browser UI of the chat app | ✅ | ✅ | ❌ | ❌ | -| [`go-peer`](./go-peer/) | Chat peer implemented in Go | ✅ | ❌ | ✅ | ✅ | -| [`rust-peer`](./rust-peer/) | Chat peer implemented in Rust | ❌ | ✅ | ✅ | ❌ | +| Packge | Description | WebTransport | WebRTC | WebRTC-direct | QUIC | TCP | +| :-------------------------- | :------------------------------ | ------------ | ------ | ------------- | ---- | --- | +| [`js-peer`](./js-peer/) | Browser Chat Peer in TypeScript | ✅ | ✅ | ✅ | ❌ | ❌ | +| [`go-peer`](./go-peer/) | Chat peer implemented in Go | ✅ | ❌ | ✅ | ✅ | ✅ | +| [`rust-peer`](./rust-peer/) | Chat peer implemented in Rust | ❌ | ❌ | ✅ | ✅ | ❌ | ✅ - Protocol supported ❌ - Protocol not supported @@ -36,8 +37,6 @@ There are two ways to connect to a peer: - With a PeerID using peer routing (adds a step to resolve the multiaddr for the PeerID), using the IPFS/Libp2p DHT, e.g. `12D3KooWLMySi3eEWscUnKmMCYRSXL3obYJ4KNimpShJK6shUy2M` - With a multiaddr directly (skips the peer routing step), e.g. `/ip4/127.0.0.1/udp/64434/webrtc/certhash/uEiA_tkndZQWf7jyFqgCiwH_CqsS7FTWFTb6Px8MPxxT9gQ/p2p/12D3KooWLMySi3eEWscUnKmMCYRSXL3obYJ4KNimpShJK6shUy2M` -[8-minute project setup & demo video](https://share.descript.com/view/wYYLohdYx5X) -git ### Using a multiaddr Load the UI, and enter the multiaddr into the UI. Ensure that it includes the peerID, e.g.`/ip4/192.168.178.21/udp/61838/quic-v1/webtransport/certhash/uEiCQCALYac4V3LJ2ourLdauXOswIXpIuJ_JNT-8Wavmxyw/certhash/uEiCdYghq5FlXGkVONQXT07CteA16BDyMPI23-0GjA9Ej_w/p2p/12D3KooWF7ovRNBKPxERf6GtUbFdiqJsQviKUb7Z8a2Uuuo6MrDX`