summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Praeger <bpr97050@gmail.com>2014-08-05 15:20:01 -0400
committerBen Praeger <bpr97050@gmail.com>2014-08-05 15:20:01 -0400
commit0e70b7cf7d831a27c7f7dec1fed3231e2d353d75 (patch)
tree3487bb747a2b75b66bb11cb364cac745d833dbe6 /README.md
parent69c8da64cf384e13a42efda46b1c3f86d0bb6bd1 (diff)
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 2c43b766..d26ea704 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,18 @@
3 3
4With the rise of governmental monitoring programs, Tox, a FOSS initiative, aims to be an easy to use, all-in-one communication platform that ensures their users full privacy and secure message delivery.<br /> <br /> 4With the rise of governmental monitoring programs, Tox, a FOSS initiative, aims to be an easy to use, all-in-one communication platform that ensures their users full privacy and secure message delivery.<br /> <br />
5 5
6[**Website**](https://tox.im) **|** [**Download**](https://github.com/irungentoo/toxcore/wiki/Downloads) **|** [**Wiki**](https://wiki.tox.im/) **|** [**Blog**](https://blog.libtoxcore.so/) **|** [**FAQ**](http://wiki.tox.im/FAQ) **|** [**Binaries**](https://wiki.tox.im/Binaries) **|** [**Clients**](https://wiki.tox.im/Client) **|** [**Compiling**](https://wiki.tox.im/Installing) **|** [**API**](https://libtoxcore.so/) **|** **IRC:** #tox@freenode 6[**Website**](https://tox.im) **|** [**Download**](https://github.com/irungentoo/toxcore/wiki/Downloads) **|** [**Wiki**](https://wiki.tox.im/) **|** [**Blog**](https://blog.libtoxcore.so/) **|** [**FAQ**](http://wiki.tox.im/FAQ) **|** [**Binaries**](https://wiki.tox.im/Binaries) **|** [**Clients**](https://wiki.tox.im/Client) **|** [**Compiling**](/INSTALL.md) **|**
7[**API**](https://libtoxcore.so/) **|**
8**IRC:** #tox@freenode
7 9
8 10
9## The Complex Stuff: 11## The Complex Stuff:
10### UDP vs. TCP 12### UDP vs. TCP
11Tox must use UDP simply because [hole punching](https://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable. 13Tox must use UDP simply because [hole punching](https://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
12However, Tox does use [TCP relays](https://github.com/irungentoo/ProjectTox-Core/blob/master/docs/TCP_Network.txt) as a fallback if it encounters a firewall that prevents UDP hole punching. 14However, Tox does use [TCP relays](/docs/TCP_Network.txt) as a fallback if it encounters a firewall that prevents UDP hole punching.
13 15
14### Connecting & Communicating 16### Connecting & Communicating
15Every peer is represented as a [byte string][String] (the public key [Tox ID] of the peer). By using torrent-style DHT, peers can find the IP of other peers by using their Tox ID. Once the IP is obtained, peers can initiate a [secure](https://github.com/irungentoo/toxcore/wiki/Crypto) connection with each other. Once the connection is made, peers can exchange messages, send files, start video chats, etc. using encrypted communications. 17Every peer is represented as a [byte string][String] (the public key [Tox ID] of the peer). By using torrent-style DHT, peers can find the IP of other peers by using their Tox ID. Once the IP is obtained, peers can initiate a [secure](/docs/updates/Crypto.md) connection with each other. Once the connection is made, peers can exchange messages, send files, start video chats, etc. using encrypted communications.
16 18
17 19
18**Current build status:** [![Build Status](https://travis-ci.org/irungentoo/toxcore.png?branch=master)](https://travis-ci.org/irungentoo/toxcore) 20**Current build status:** [![Build Status](https://travis-ci.org/irungentoo/toxcore.png?branch=master)](https://travis-ci.org/irungentoo/toxcore)
@@ -34,9 +36,8 @@ The goal of this project is to create a configuration-free P2P Skype replacement
34## Documentation: 36## Documentation:
35 37
36- [Compiling](/INSTALL.md) 38- [Compiling](/INSTALL.md)
37- [DHT Protocol](https://wiki.tox.im/index.php/DHT)<br /> 39- [DHT Protocol](/docs/updates/DHT.md)<br />
38- [Lossless UDP Protocol](https://wiki.tox.im/index.php/Lossless_UDP)<br /> 40- [Crypto](/docs/updates/Crypto.md)<br />
39- [Crypto](https://wiki.tox.im/index.php/Crypto)<br />
40- [Ideas](https://wiki.tox.im/index.php/Ideas) 41- [Ideas](https://wiki.tox.im/index.php/Ideas)
41 42
42[String]: https://en.wikipedia.org/wiki/String_(computer_science) 43[String]: https://en.wikipedia.org/wiki/String_(computer_science)