Add help texts and update README

This commit is contained in:
vanitasvitae 2017-08-15 17:53:50 +02:00
parent fcd0a7ce8c
commit 49c25c97d5
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
3 changed files with 24 additions and 2 deletions

8
README.md Normal file
View file

@ -0,0 +1,8 @@
# GSoC 2017 - Jingle File Transfer Demo App
File synchronisation via XMPP.
xmpp_sync has two modes: Master and Slave mode. A client started in master mode will send files
out, while clients in slave mode will receive files.
In order to use the program, you need at least two XMPP accounts (which might be on different
servers). I recommend using a server, which supports Socks5 proxies.