aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2018-11-06 15:03:22 +0100
committerAlex Auvolat <alex@adnab.me>2018-11-06 15:03:22 +0100
commit2973cf99c5b677c71717d916f83212bc2e6b36dc (patch)
tree8651b326786c62fc4e0bc438a625a13bf5df1844 /README.md
parentc4f6cbab20b0b1d08755073d93365e5bd00dc755 (diff)
downloadshard-2973cf99c5b677c71717d916f83212bc2e6b36dc.tar.gz
shard-2973cf99c5b677c71717d916f83212bc2e6b36dc.zip
Document
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index c247e4e..db52b04 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,8 @@ Current status
What is available
-----------------
+All of these are rudimentary prototypes at an early stage.
+
* Chat rooms (public and private) with full history and efficient data structure for
retrieving missing messages after disconnection
* File upload (public only)
@@ -99,6 +101,8 @@ See `TODO` file for more details.
* Finding peers via DHT (very easy to add)
* Invite/notification system
* Good access control
+* Good networking behind NAT/Firewall
+* Automatic discovery on local networks
* More applications
How to use it?
@@ -217,4 +221,5 @@ This CLI supports a few basic commands:
- `/pm nickname1 [nickname2] [...]`: enter private conversation with someone
- `/send_file path`: make file available on the network and send link to current chat room.
**WARNING: all files are publicly available for now, even if they are sent in a private chat room.**
+- `/shards`: return the list of all shards on the system
- `/quit`: return to iex prompt