diff --git a/README.md b/README.md index 6a76f23..6fcfb7e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# Transmat +# Transphase +This is a collection of tools to copy files or proxy connections via WebSockets protocol. +It is done in a cryptographically safe(ish) way. +A rendevouz/relay server is used to help with data transfer. +**Transphase** - the relay server +**Transmat** - tool to copy files/directories +**Transplace** - HTTP proxy/exit point + +### Copy files +Transphase server should be running and accessible by the parties. +On the sending party: +``` +transmat --send +``` +This will prepare the sender and output the command to run on the receiving party, eg: +``` +transmat --receive --password Space-Time-Continuum +``` + +See also ```transmat --help```. \ No newline at end of file