Skip to content

Commit 77401f5

Browse files
author
shijiashuai
committed
docs: add index.md landing page for GitHub Pages
1 parent 35f9c8d commit 77401f5

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

index.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
layout: default
3+
title: WebRTC
4+
---
5+
6+
# WebRTC
7+
8+
基于 Go 的最小可用 WebRTC 示例项目 — WebSocket 信令服务器与浏览器端 Demo,适合作为实时音视频应用的入门模板。
9+
10+
## 核心特性
11+
12+
- **WebSocket 信令** — Gorilla WebSocket 实现房间内 Offer/Answer/ICE Candidate 转发
13+
- **浏览器前端** — 一键采集音视频并发起点对点呼叫
14+
- **Go Modules** — 依赖管理,便于扩展与部署
15+
- **可扩展架构** — 可进一步接入 TURN/SFU/录制等能力
16+
17+
## 文档
18+
19+
- [README](README.md) — 项目概述与快速开始
20+
- [使用指南](docs/guide.md) — 详细使用教程
21+
- [信令协议](docs/signaling.md) — WebSocket 信令协议文档
22+
23+
## 架构
24+
25+
```
26+
Browser ──HTTP GET /──→ HTTP 静态文件
27+
Browser ──WebSocket /ws──→ Signal Hub
28+
Browser ──WebRTC 媒体通道──→ 远端浏览器
29+
```
30+
31+
## 快速开始
32+
33+
```bash
34+
# 克隆项目
35+
git clone https://github.com/LessUp/WebRTC.git
36+
cd WebRTC
37+
38+
# 运行服务器
39+
go run cmd/server/main.go
40+
41+
# 浏览器访问 http://localhost:8080
42+
```
43+
44+
## 技术栈
45+
46+
| 类别 | 技术 |
47+
|------|------|
48+
| 后端 | Go 1.22+ |
49+
| 信令 | Gorilla WebSocket |
50+
| 前端 | HTML + JavaScript |
51+
| 容器 | Docker |
52+
53+
## 链接
54+
55+
- [GitHub 仓库](https://github.com/LessUp/WebRTC)
56+
- [README](README.md)

0 commit comments

Comments
 (0)