aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Smeding <tom.smeding@gmail.com>2020-07-11 17:59:10 +0200
committerTom Smeding <tom.smeding@gmail.com>2020-07-11 17:59:10 +0200
commita0672edaeaf9f4da0e9f6bf6dbe787e1386fa713 (patch)
tree83caef874fae73c6127c64b927e9ea6b6d4bd168
parentd5e66d8f51e41841356b9b268e8a4a9ec4b7828f (diff)
Update README.md to refer to protocol documentation
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index dda64d4..d41d4bc 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,7 @@ tomsg is a simple chat server with a couple of clients: a webpage, a
[weechat](https://weechat.org/) plugin and an Android app. Its main interface
is over a TCP socket, but there is a websocket bridge to support web access.
There is basically no security. The storage backend is an SQLite database.
+
+The client-server protocol is documented in `protocol.md`; however, for
+security, clients should always connect through either the SSH proxy or the
+websocket proxy behind an SSL terminator.