Skip to content

Commit dafb13d

Browse files
committed
fix: doc
1 parent 08541f5 commit dafb13d

File tree

1 file changed

+29
-31
lines changed

1 file changed

+29
-31
lines changed

README.md

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,75 @@
11
# PeerChat
22

3+
A real-time peer-to-peer chat application built with WebRTC technology. Enables direct communication between users without requiring a central server, featuring a clean interface and smooth chat experience.
34

5+
## Features
46

5-
PeerChat是一个基于WebRTC技术的实时点对点聊天应用,无需中心服务器即可实现用户之间的直接通信。提供了简洁直观的用户界面和流畅的聊天体验。
7+
### Decentralized Communication
68

7-
## 功能特点
9+
- Direct P2P communication via WebRTC
810

9-
### 去中心化通信
11+
- No central server for message storage, protecting user privacy
1012

11-
- 基于WebRTC的P2P直接通信
13+
- NAT traversal support for various network environments
1214

13-
- 无需中央服务器存储消息,保护用户隐私
15+
### Group Chat
1416

15-
- 支持NAT穿透,适用于各种网络环境
17+
- Create and join group chats
1618

17-
### 群聊功能
19+
- Host/member role distinction
1820

19-
- 支持创建和加入群聊
21+
- Real-time online member display
2022

21-
- 主持人/成员角色区分
23+
### User-Friendly Interface
2224

23-
- 实时显示在线成员
25+
- Intuitive chat interface with message type differentiation
2426

25-
### 用户友好界面
27+
- Special indicators for host messages
2628

27-
- 直观的聊天界面,区分不同类型消息
29+
- Message status display (sending, sent, etc.)
2830

29-
- 主持人消息特殊标识
31+
### Instant Sharing
3032

31-
- 消息状态显示(发送中、已发送等)
33+
- Generate shareable group chat links
3234

33-
### 即时分享
35+
- Quick join via links or IDs
3436

35-
- 生成可分享的群聊链接
36-
37-
- 通过链接或ID快速加入群聊
38-
39-
## 技术栈
37+
## Tech Stack
4038

4139
- React + TypeScript + Vite + PeerJS
4240

43-
## 本地开发
41+
## Local Development
4442

4543
```bash
46-
# 安装依赖
44+
# Install dependencies
4745
npm install
4846

49-
# 启动开发服务器
47+
# Start development server
5048
npm run dev
5149

52-
# 构建生产版本
50+
# Build for production
5351
npm run build
5452

55-
# 预览生产构建
53+
# Preview production build
5654
npm run preview
5755

58-
# 部署到 GitHub Pages
56+
# Deploy to GitHub Pages
5957
npm run deploy
6058
```
6159

62-
## 在线演示
60+
## Live Demo
6361

64-
访问 [https://sumingcheng.github.io/PeerChat/](https://sumingcheng.github.io/PeerChat/) 查看在线演示。
62+
Visit [https://sumingcheng.github.io/PeerChat/](https://sumingcheng.github.io/PeerChat/) for live demo.
6563
![image](https://github.com/user-attachments/assets/86215de5-b733-4210-853d-b19925e22539)
6664
![image](https://github.com/user-attachments/assets/e3885b5a-19cc-4405-9c87-a8134fcc8398)
6765
![image](https://github.com/user-attachments/assets/9148dc49-d901-40c3-b050-1807a74b024c)
6866
![image](https://github.com/user-attachments/assets/fda512dc-450f-4554-bcb7-516f344f9813)
6967

70-
## 许可证
68+
## License
7169

7270
Apache License Version 2.0
7371

74-
## 基本概念图示
72+
## Architecture Overview
7573
![1](https://github.com/user-attachments/assets/29aac949-138b-4e2f-ae4c-a099fae9b8b6)
7674

77-
## 捐赠
75+
## Donation

0 commit comments

Comments
 (0)