diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..677518a --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# PY-CHAT +Create or join a private chatroom without any third-party middlemen in less than 30 seconds, available through an AES encrypted password protected link. + +## Usage +**Creating a chatroom** +1. Enter "create" +2. Enter your address + * **Example:** localhost + * **Example:** localhost:5555 +3. Enter your forwarded port address (optional) + * **Example:** 2.tcp.eu.ngrok.io:18413 +4. Choose your chatroom password (hidden) +5. Save the chatroom link +6. Choose your username + +**Joining a chatroom** +1. Enter "join" +2. Paste the chatroom link +3. Enter the chatroom password (hidden) +4. Choose your username + +## Features +* AES Encrypted Link +* TLS Encrypted Messages +* Forwarded Port Support +* Connect / Disconnect Notices + +--- + +## Requirements +* [Python 3.8+](https://www.python.org/downloads/release/python-380) +* cryptography +* curses + +## Installation +* git clone https://git.alvinhavel.com/PY-CHAT && cd cd PY-CHAT +* **Windows** + * pip install cryptography pyinstaller pipwin && pipwin install curses + * python PY-CHAT.py +* **Mac / Linux** + * pip3 install cryptography curses pyinstaller + * python3 PY-CHAT.py + +## Executable +* pyinstaller -F -i PY-CHAT.ico PY-CHAT.py |