British-Information-Technologies
/
ChatKit-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added docs?

This commit is contained in:
michael-bailey 2024-04-18 12:48:05 +01:00
parent f33bfd1a38
commit 1862ae0d34
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/index.md Normal file
View File

@ -0,0 +1,10 @@
# Chat Kit
This is a self hosted, distributed shat system.
It derives a lot of ideas from Discord, IRC and RCS.
This repository contains a couple of crates.
- Protocol: The protocol message structures
- Foundation: Shared structures and functions utilised in the server and client crate.
- Server: The server that accepts client connections and manages state between them.
- Client: A basic terminal client, used for testing and will be unstable.