Create README.md

This commit is contained in:
Daniella / Tove 2022-08-13 12:29:47 +02:00 committed by GitHub
parent 73eba2a0d6
commit 775aa5add8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# qft
QFT is a small command line application for Quick Peer-To-Peer UDP file transfer.
## Usage:
- Find a public QFT helper (for example tudbut.de:4277)
- On the sender PC, enter `qft sender <helper> <shared-phrase> <filename>`.
- On the receiver PC, enter `qft receiver <helper> <shared-phrase> <filename>`.
- Both PCs should start transferring after a short while. If they don't, try again.
## Tips 'n Tricks
- You can add a number to the end of both of your commands (after the filename) to
boost transfer speeds (higher = faster), but a too large number might cause unreliability
due to local network conditions or VPNs.
## Troubleshooting
### It constantly says `CONNECTING`
One of your ends didn't correctly connect to the helper. Stop the transfer on both ends
and try again.