Skip to content

Commit 7b4bbea

Browse files
authored
Update README.md
1 parent c373360 commit 7b4bbea

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

Diff for: README.md

+39-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
1-
# Python-Chat
2-
Custom python chat app
1+
---
2+
3+
# 📨 Python Chat
4+
5+
Python Chat is a simple chat system built with **sockets** in Python. It allows **communication between a server and a client** over a local network.
6+
7+
## 🚀 Features
8+
- 📡 **Server & Client** – Easy setup for both server and client
9+
- 💬 **Real-time Messaging** – Instant message exchange between users
10+
- 🔒 **Local Connection** – Works on `127.0.0.1` for testing
11+
12+
## ⚠️ Requirements
13+
- Python 3.x
14+
- Local network connection
15+
16+
## 📥 Installation & Usage
17+
18+
### 1️⃣ Start the Server
19+
```bash
20+
python "PythonChat Server.py"
21+
```
22+
Enter the **port number** for the server.
23+
24+
### 2️⃣ Start the Client
25+
```bash
26+
python "PythonChat Client.py"
27+
```
28+
Enter the **server’s port number** and your **name**.
29+
30+
## 🛠 How to Use
31+
1. **Run the server** and wait for a client to connect
32+
2. **Run the client** and connect to the server
33+
3. Send messages and chat in real-time
34+
35+
## 📌 Notes
36+
- **For local use only** (`127.0.0.1`)
37+
- Press **Ctrl + C** to stop the server/client
38+
39+
---

0 commit comments

Comments
 (0)