From f7cd620c5607cd9b4a2a62583ea2085e7138be67 Mon Sep 17 00:00:00 2001 From: myitinos Date: Tue, 23 Apr 2019 10:54:44 +0800 Subject: [PATCH] populate the readme --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 1169300..2f261ea 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # chat-app +Table of Contents + +- [chat-app](#chat-app) + - [Server](#server) + - [Client](#client) + - [Thanks to](#thanks-to) + +This is a simple chat app that use socket for connection, and it's clients side can use `netcat` to connect or use the provided client side script to open a GUI client using tkinter. + +## Server + +You can run the server side script inside the server subdirectory by using: + +`__main__.py HOST PORT` + +or + +`__main__.py -h` + +to see the full help dialog + +## Client + +You can run the client side script inside the client subdirectory by using: + +`__main__.py HOST PORT` + +or + +`__main__.py -h` + +to see the full help dialog + +## Thanks to +Thanks to these two article as my inspiration + + - https://www.geeksforgeeks.org/simple-chat-room-using-python + - https://medium.com/swlh/lets-write-a-chat-app-in-python-f6783a9ac170