summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorsin <sin@2f30.org>2014-09-23 14:03:49 +0100
committersin <sin@2f30.org>2014-09-23 14:03:49 +0100
commit694cc151f52136c0e7fbfe6506e65fdf558fa702 (patch)
tree02fd42b7f5eee758fbe634d61488660774e0967d /README
parentfc256a293089082871342430d7e699a5a26c0379 (diff)
Add README
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a11b118
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+What is it?
+===========
+
+ratox is a client implementation of the rather popular tox protocol.
+Unlike other clients relying on GUIs as an interface to the user,
+ratox is developed with the UNIX-philosophy in mind and allows complete
+interaction through named pipes.
+
+Features
+========
+
+1 v 1 messaging: Yes
+File transfer: Sending only
+Group chat: No
+Audio: No
+Video: No
+DNS discovery: No
+Chat logs: Yes
+Proxy support: No
+Offline message: Yes
+Contact aliases: No
+Contact blocking: No
+Save file encryption: Yes
+Multilingual: No
+Multiprofile: Yes
+Typing notification: No
+Audio notifications: No
+Emoticons: No
+Spell check: No
+Desktop sharing: No
+Inline images: No
+File resuming: No
+Read receipts: No
+Message splitting: No
+Changing nospam: No
+toxi URI: No
+
+NOTE: Some of these features are not intended to be developed
+in ratox itself but rather in external scripts that are built upon
+ratox.