Skip to content

Commit 1924725

Browse files
committed
update README
1 parent 6a8c3c6 commit 1924725

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
11
### 项目说明
22
face_coding顾名思义面对面共享代码
33

4+
### 启动方式
5+
```shell
6+
## yarn start 可以替换为npm start
7+
# Windows (cmd.exe)
8+
set HTTPS=true&&yarn start
9+
10+
# Windows (Powershell)
11+
($env:HTTPS = "true") -and (yarn start)
12+
13+
# Linux, macOS (Bash)
14+
HTTPS=true yarn start
15+
```
16+
17+
418
#### 功能说明
519

620
- 1. 实时共享代码编辑器
@@ -19,8 +33,15 @@ face_coding顾名思义面对面共享代码
1933
|音视频通话||WebRTC|基于Janus|
2034
|代码编辑器||codeMirror|-|
2135
|文字聊天||WebRTC|WebRTC dataChannel|
22-
|屏幕共享||WebRTC|-|
36+
|屏幕共享||WebRTC|-|
37+
|声音监控||WebRTC|-|
2338
|录制功能||WebRTC|-|
2439

40+
### 有待优化项
41+
- 1. 退出房间的后续处理
42+
- 2. 声音激励的检测
43+
- 3. 选择设备和切换设备功能
44+
- 4. 聊天共享上下文
45+
2546
#### 后续计划
2647
购买服务器:) 实现房间管控 提升编辑器共享文字的性能 对dataChannel的文字进行加密处理

0 commit comments

Comments
 (0)