summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGregory Mullen (grayhatter) <greg@grayhatter.com>2016-08-13 14:18:40 -0700
committerGregory Mullen (grayhatter) <greg@grayhatter.com>2016-08-14 12:03:26 -0700
commite43bde37eac9dc235619ee4c696796292e3e5256 (patch)
tree34633828930015b82d1a50f3d24369f94048ffa2 /README.md
parent35932b5381886f1d650d2cf853384273d080b821 (diff)
Update readme with tentative roadmap, removed old todo.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 37 insertions, 16 deletions
diff --git a/README.md b/README.md
index 93ed47bb..b69aef24 100644
--- a/README.md
+++ b/README.md
@@ -4,37 +4,58 @@
4**Current build status:** [![Build Status](https://travis-ci.org/TokTok/toxcore.svg?branch=master)](https://travis-ci.org/TokTok/toxcore) 4**Current build status:** [![Build Status](https://travis-ci.org/TokTok/toxcore.svg?branch=master)](https://travis-ci.org/TokTok/toxcore)
5**Current Coverage:** [![Coverage Status](https://coveralls.io/repos/github/TokTok/toxcore/badge.svg?branch=master)](https://coveralls.io/github/TokTok/toxcore?branch=master) 5**Current Coverage:** [![Coverage Status](https://coveralls.io/repos/github/TokTok/toxcore/badge.svg?branch=master)](https://coveralls.io/github/TokTok/toxcore?branch=master)
6 6
7With the rise of government surveillance programs, Tox, a FOSS initiative, aims to be an easy to use, all-in-one communication platform that ensures full privacy and secure message delivery.<br /> <br />
8
9[**Website**](https://tox.chat) **|** [**Wiki**](https://wiki.tox.chat/) **|** [**Blog**](https://blog.tox.chat/) **|** [**FAQ**](https://wiki.tox.chat/doku.php?id=users:faq) **|** [**Binaries/Downloads**](https://wiki.tox.chat/Binaries) **|** [**Clients**](https://wiki.tox.chat/doku.php?id=clients) **|** [**Compiling**](/INSTALL.md) 7[**Website**](https://tox.chat) **|** [**Wiki**](https://wiki.tox.chat/) **|** [**Blog**](https://blog.tox.chat/) **|** [**FAQ**](https://wiki.tox.chat/doku.php?id=users:faq) **|** [**Binaries/Downloads**](https://wiki.tox.chat/Binaries) **|** [**Clients**](https://wiki.tox.chat/doku.php?id=clients) **|** [**Compiling**](/INSTALL.md)
10 8
11**IRC Channels:** [#tox@freenode](https://webchat.freenode.net/?channels=tox), [#toktok@freenode](https://webchat.freenode.net/?channels=toktok) 9**IRC Channels:** [#tox@freenode](https://webchat.freenode.net/?channels=tox), [#toktok@freenode](https://webchat.freenode.net/?channels=toktok)
12 10
11## Q&A:
13 12
14## The Complex Stuff: 13### What is Tox?
15### UDP vs. TCP
16Tox must use UDP simply because [hole punching](https://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
17However, Tox does use [TCP relays](/docs/TCP_Network.txt) as a fallback if it encounters a firewall that prevents UDP hole punching.
18 14
19### Connecting & Communicating 15Tox is a fully encrypted, censor resistant, private, distributed network library with a focus on personal communications.
20Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (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.
21 16
17### No, really, what's Tox?
22 18
23## Q&A: 19It's a VERY secure Instant Messenger that supports Text, Audio/Video calls, group chats, audio group chats, and file transfers.
24 20
25### What are your goals with Tox? 21### What are your goals with Tox?
26 22
27We want Tox to be as simple as possible while remaining as secure as possible. 23We want Tox to be as simple as possible while remaining as secure as possible.
28 24
29### Why are you doing this? There are already a bunch of free Skype alternatives. 25## Toxcore Roadmap
30The goal of this project is to create a configuration-free P2P Skype replacement. “Configuration-free” means that the user will simply have to open the program and will be capable of adding people and communicating with them without having to set up an account. There are many so-called Skype replacements, but all of them are either hard to configure for the normal user or suffer from being way too centralized. 26This Roadmap is somewhat tentative, but should give you a good idea of where
31 27we're going, and where we've been.
32## TODO: 28
33- [TODO](/docs/TODO.md) 29Currently unsorted, the following is intended to function as a discussion guide
34 30to developers/contributors.
31
32### In Progress
33- [ ] 100% unit testing
34- [ ] Make toxcore stateless
35- [ ] Allow a single toxcore instance to handle multiple keypairs
36- [ ] Implement usable group chats
37- [ ] Improve A/V implementation
38- [ ] Multiple device support
39- [ ] Consistent naming scheme throughout toxcore
40
41### Done
42- [X] Create Toxcore
43- [X] Create DHT
44- [X] Create Onion
45- [X] Implement Crypto
46- [X] Create Messenger
35 47
36## Documentation: 48## Documentation:
37
38- [Compiling](/INSTALL.md) 49- [Compiling](/INSTALL.md)
39- [DHT Protocol](/docs/updates/DHT.md)<br /> 50- [DHT Protocol](/docs/updates/DHT.md)<br />
40- [Crypto](/docs/updates/Crypto.md)<br /> 51- [Crypto](/docs/updates/Crypto.md)<br />
52
53## The Complex Stuff:
54### UDP vs. TCP
55Tox must use UDP simply because [hole punching](https://en.wikipedia.org/wiki/UDP_hole_punching) with TCP is not as reliable.
56However, Tox does use [TCP relays](/docs/TCP_Network.txt) as a fallback if it encounters a firewall that prevents UDP hole punching.
57
58### Connecting & Communicating
59Every peer is represented as a [byte string](https://en.wikipedia.org/wiki/String_(computer_science)) (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.
60
61