summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGregory Mullen (grayhatter) <greg@grayhatter.com>2016-10-17 11:23:09 -0700
committerGregory Mullen (grayhatter) <greg@grayhatter.com>2016-10-17 11:26:17 -0700
commit405dd9bcec9454f52c2e13ea08b55001b663d0b4 (patch)
treef14a255cc25919cef42bc91723b3f2fdb432ed6c /README.md
parent6d0c8060c1e1034a5d5047799b0493c137e53364 (diff)
Update readme, moved the roadmap to a higher position
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 27 insertions, 25 deletions
diff --git a/README.md b/README.md
index b69aef24..97bcd6b8 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,14 @@
1![Project Tox](https://raw.github.com/TokTok/toxcore/master/other/tox.png "Project Tox") 1![Project Tox](https://raw.github.com/TokTok/toxcore/master/other/tox.png "Project Tox")
2*** 2***
3 3
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/c-toxcore.svg?branch=master)](https://travis-ci.org/TokTok/c-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
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) 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)
8 8
9**IRC Channels:** [#tox@freenode](https://webchat.freenode.net/?channels=tox), [#toktok@freenode](https://webchat.freenode.net/?channels=toktok) 9**IRC Channels:** Users: [#tox@freenode](https://webchat.freenode.net/?channels=tox), Developers: [#toktok@freenode](https://webchat.freenode.net/?channels=toktok)
10 10
11## Q&A: 11## Toxcore Development Roadmap
12
13### What is Tox?
14
15Tox is a fully encrypted, censor resistant, private, distributed network library with a focus on personal communications.
16
17### No, really, what's Tox?
18
19It's a VERY secure Instant Messenger that supports Text, Audio/Video calls, group chats, audio group chats, and file transfers.
20
21### What are your goals with Tox?
22
23We want Tox to be as simple as possible while remaining as secure as possible.
24
25## Toxcore Roadmap
26This Roadmap is somewhat tentative, but should give you a good idea of where 12This Roadmap is somewhat tentative, but should give you a good idea of where
27we're going, and where we've been. 13we're going, and where we've been.
28 14
@@ -30,13 +16,16 @@ Currently unsorted, the following is intended to function as a discussion guide
30to developers/contributors. 16to developers/contributors.
31 17
32### In Progress 18### In Progress
33- [ ] 100% unit testing 19- [ ] Toxcore
34- [ ] Make toxcore stateless 20 - [ ] 100% unit testing
35- [ ] Allow a single toxcore instance to handle multiple keypairs 21 - [ ] Make ToxAV stateless
36- [ ] Implement usable group chats 22 - [ ] Allow a single toxcore instance to handle multiple keypairs (or 'clients')
37- [ ] Improve A/V implementation 23 - [ ] Consistent naming scheme throughout toxcore
38- [ ] Multiple device support 24 - [X] Make toxcore stateless
39- [ ] Consistent naming scheme throughout toxcore 25- [ ] Messenger
26 - [ ] Improve group chat implementation
27 - [ ] Improve A/V implementation
28 - [ ] Multiple device support
40 29
41### Done 30### Done
42- [X] Create Toxcore 31- [X] Create Toxcore
@@ -45,6 +34,20 @@ to developers/contributors.
45- [X] Implement Crypto 34- [X] Implement Crypto
46- [X] Create Messenger 35- [X] Create Messenger
47 36
37## Q&A:
38
39### What is Tox?
40
41Tox is a fully encrypted, censor resistant, private, distributed network library with a focus on personal communications.
42
43### No, really, what's Tox?
44
45It's a VERY secure Instant Messenger that supports Text, Audio/Video calls, group chats, audio group chats, and file transfers. There's dozens, but our advantage is we put security first, from day 1. We didn't decide to add it in after.
46
47### What are your goals with Tox?
48
49We want Tox to be as simple as possible while remaining as secure as possible.
50
48## Documentation: 51## Documentation:
49- [Compiling](/INSTALL.md) 52- [Compiling](/INSTALL.md)
50- [DHT Protocol](/docs/updates/DHT.md)<br /> 53- [DHT Protocol](/docs/updates/DHT.md)<br />
@@ -58,4 +61,3 @@ However, Tox does use [TCP relays](/docs/TCP_Network.txt) as a fallback if it en
58### Connecting & Communicating 61### 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. 62Every 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 63
61