From d54303dc614f6d7c6418b6656394340b4174b1b5 Mon Sep 17 00:00:00 2001 From: michael bailey Date: Wed, 28 Jul 2021 15:46:37 +0100 Subject: [PATCH 1/2] Update README.md + added feature, todo and goals section. --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index de85e4c..d8d5f60 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -# rust-chat-server \ No newline at end of file +# Rust-chat-server + +A Chat server writen in rust to allow communication between peers. + +--- + +## Features: +- implemented: + - json based API. + - Server introspection. + - Peer discovery. + - sending messages to connected clients. + - +- todo: + - Encryption to server. + - server to server meshing. + - asynchronous client managment instead of threaded approach. + +## Goals: +- Learn the rust programming lanaguage. + - Ownership: how that affects normal programming styles. + - Borrowing and references: how this affects shared state. + - Lifetimes: how this affects data retention and sharing. +- Learn how to create networked programs. + - Application level protocol: how to get two programs to communicate via TCP sockets. + - Socket handling: Discovering ways to handle multiple socket connections without affecting performance. +- Learn common encryption protocols. + - Adding support for encrypted sockets. + - Pros and cons of symetric and asymetric encryption. + - resolving common encryption flaws + +> Questoins: For questions please add a issue with the question label. It will eventually be responded to -- 2.40.1 From 96e7410fb2d2e00d43e20691fe1487cff7904ec0 Mon Sep 17 00:00:00 2001 From: michael bailey Date: Wed, 28 Jul 2021 15:56:35 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8d5f60..260be15 100644 --- a/README.md +++ b/README.md @@ -29,4 +29,4 @@ A Chat server writen in rust to allow communication between peers. - Pros and cons of symetric and asymetric encryption. - resolving common encryption flaws -> Questoins: For questions please add a issue with the question label. It will eventually be responded to +> Questions: For questions please add a issue with the question label. It will eventually be responded to -- 2.40.1