snxraven/sshChat-CLI
1
1
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updating readme

Browse Source
This commit is contained in:
Raven Scott 2023-01-08 22:28:12 -05:00
parent bbf1202806
commit 1b1a4a1c1e
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,6 +1,18 @@
# SSH Chat # 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: To install:
@ -54,4 +66,3 @@ Running commands while logged in:
If a user does not login they will have a random annon1234 username. If a user does not login they will have a random annon1234 username.