AtHeartEngineer/universal-connectivity
1
0
Fork 0
mirror of https://github.com/vacp2p/universal-connectivity.git synced 2026-01-08 22:58:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme (#204)

Browse Source
This commit is contained in:
Daniel Norman
2024-11-01 09:36:34 +01:00
committed by GitHub
parent 6e8e03d993
commit 370dbbacd1
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -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`