fluora
/
sunbeam
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed readme, added more mes

This commit is contained in:
Ellie D 2019-06-01 01:26:12 -05:00
parent 4e6ab0d40a
commit 9b7f51d76a
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -12,8 +12,8 @@ and remote addresses (strings like [ip address]:[port]). For each address argume
Sunbeam attempts to connect to that address, and for each port argument, it listens for incoming
connections on that port locally. Whenever it receives data over any connection, that data is
promptly retransmitted to all other connections, save for two exceptions:
- Data is not passed between clients that connect to Sunbeam on the same port.
- Data is not passed between servers that Sunbeam connects to.
- Data is not passed between clients that connect to Sunbeam on the same port.
- Data is not passed between servers that Sunbeam connects to.
For example, Sunbeam can be used as a relay for an audio stream by giving it the address of the
stream server and a local port. Clients connecting to the local port will receive the stream data,
but if one client sends data back to Sunbeam, it will not interfere with other clients' streams
@ -23,6 +23,9 @@ clients and servers except the one which originated the data. Sunbeam automatica
loopback mode if no ports are specified, or if only one port and no addresses are specified. You
can also pass the `-l` flag to require Sunbeam to run in loopback mode.
General usage looks like the following:
`sunbeam [-l] [local port] [remote address]:[port]`
This program is called "Sunbeam" because of a particular plot device that we thought was clever
in the sci-fi novel *The Three Body Problem* by Cixin Liu. A character discovers that, due to a
particular plasma-driven mechanism inside the sun, it's possible to use the sun as a gigantic