From 558a94627a7b20cdd022e11172d9e590429db27c Mon Sep 17 00:00:00 2001 From: Kayomn Date: Fri, 1 Oct 2021 00:25:00 +0100 Subject: [PATCH] Fill in readme --- readme.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/readme.md b/readme.md index 8b13789..1b7f082 100644 --- a/readme.md +++ b/readme.md @@ -1 +1,9 @@ +Chattle is a chat client and server designed to demonstrate the basics of implementing communication protocols over a network. +Out of the box, Chattle comes with: + + * JSON-encoded byte buffer protocol for transporting authored messages over a network. + * Multi-client server capable of broadcasting messages between clients and acting as the communication authority. + * Command framework built into the messaging protocol for sending slash commands over the network. Out of the box, only a `/quit` command is provided. + +Chattle lacks any security layers to its protocol, its transport format could be more efficient, and user IPs are made visible to every connected client. It is intended to be used as a foundation for experimentation and learning.