From 1b1a4a1c1e0508b7581ac6edc84ea306dd5248ee Mon Sep 17 00:00:00 2001 From: Raven Scott Date: Sun, 8 Jan 2023 22:28:12 -0500 Subject: [PATCH] updating readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f215925..7a33972 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ # SSH Chat -A Peer to Peer chat client using Hyper-Protocol. +A Peer to Peer chat client using [Hyper-Protocol](https://docs.holepunch.to/) +: + + A high-level API for finding and connecting to peers who are interested in a "topic." +[@hyperswarm/dht](https://docs.holepunch.to/building-blocks/hyperswarm#dht) +: A DHT powering Hyperswarm. Through this DHT, each server is bound to a unique key pair, with the client connecting to the server using the server's public key. +[@hyperswarm/secretstream](https://docs.holepunch.to/building-blocks/hyperswarm#secretstream) +: Secretstream is used to securely create connections between two peers in Hyperswarm. + +Hyperswarm allows you to find and connect to peers who are announcing a common "topic". The swarm topic can be anything. This means that, with Hyperswarm, you can discover and connect peers with a shared interest over a distributed network. As an example, we often use Hypercore's discovery key as the swarm topic for discovering peers to replicate with. +Once Hyperswarm has discovered peers, nodes in the DHT help those peers connect via a UDP-based hole-punching algorithm that's designed to work well in home networks. + +https://docs.holepunch.to/building-blocks/hyperswarm To install: @@ -54,4 +66,3 @@ Running commands while logged in: If a user does not login they will have a random annon1234 username. -