kd/sshChat-CLI
1
0
Fork 0
forked from snxraven/sshChat-CLI
Code Pull Requests Activity

updating readme hahah last time

Browse Source
This commit is contained in:
Raven Scott 2023-01-08 22:31:52 -05:00
parent 883a7f1263
commit 1c32f1f2ca
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,16 +1,27 @@
# SSH Chat # SSH Chat
A Peer to Peer chat client using [Hyper-Protocol](https://docs.holepunch.to/): 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." 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/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.
## What is 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. 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. 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 https://docs.holepunch.to/building-blocks/hyperswarm
## Usage
To install: To install:
`git clone git@git.codingvm.codes:snxraven/sshChat-CLI.git` `git clone git@git.codingvm.codes:snxraven/sshChat-CLI.git`
@ -53,7 +64,7 @@ To connect to an altready made topic (room) pass the hash on start up:
/stats - Get the containers stats /stats - Get the containers stats
Screenshots: ## Screenshots:
A simple convo: A simple convo:
![ScreenShot](https://media.discordapp.net/attachments/818514972610134069/1061846943556435978/Unsaved_Image_1.jpg?width=1215&height=660) ![ScreenShot](https://media.discordapp.net/attachments/818514972610134069/1061846943556435978/Unsaved_Image_1.jpg?width=1215&height=660)