Browse Source

populate the readme

master
myitinos 5 years ago
parent
commit
f7cd620c56
1 changed files with 38 additions and 0 deletions
  1. +38
    -0
      README.md

+ 38
- 0
README.md View File

@ -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

Loading…
Cancel
Save