docs: readme

README.md

@@ -1,35 +1,43 @@
-# 简介
+<p align="center">
+  <a href="">
+    <img
+      width="200"
+      src="https://resource.hsslive.cn/image/1613141138717Billd.webp"
+      alt="Billd-Live logo"
+    />
+  </a>
+</p>
 
-billd 直播间（前端），目前实现了类似 bilibili 的直播功能，即你可以发布直播，别人进入你的直播房间后能看到你的直播内容。
+<h1 align="center">
+  Billd-Live
+</h1>
 
-前后端主要的技术栈：
+<p align="center">
+  基于Vue3 + WebRtc + Node + SRS + FFmpeg搭建的直播间
+</p>
 
-- webrtc 相关 api（[RTCPeerConnection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)）
-- [vue3](https://vuejs.org) 以及相关技术栈
-- [nodejs](https://nodejs.org) 以及相关技术栈
-- [socket.io](https://socket.io)
-- [coturn](https://github.com/coturn/coturn)
+## 简介
 
-# 后端
+billd 直播间，目前实现了类似 [bilibili 的 Web 在线直播](https://live.bilibili.com)功能，即你（房主）可以发布直播，别人进入你的直播间后能看到你的直播内容；而你也可以作为观众，进入别人的直播间看别人的直播内容。
 
-[https://github.com/galaxy-s10/billd-live-server](https://github.com/galaxy-s10/billd-live-server)
+> 后端：[https://github.com/galaxy-s10/billd-live-server](https://github.com/galaxy-s10/billd-live-server)
 
-# 赞助
+## 功能
 
-[https://live.hsslive.cn/sponsors](https://live.hsslive.cn/sponsors)
+- [x] 原生 webrtc 推拉流
+- [x] srs webrtc 推流， `webrtc` 或 `http-flv` 拉流
+- [ ] [obs](https://github.com/obsproject/obs-studio)推流
+- [x] 支付宝打赏
+- [ ] 用户模块
+- [ ] 订单模块
+- [ ] 礼物模块
+- [ ] 在线后台
+- [ ] 适配移动端
+- [ ] 敬请期待！
 
-# 贡献
+## 预览
 
-> 如果你对该项目有感兴趣或想法，欢迎一起加入开发
-
-<div>
-  <img
-    src="https://resource.hsslive.cn/image/004ee8afb2e6e725df743d0623dfd801.webp" 
-    style="width:300px"
-    />
-</div>
-
-# 演示
+- [https://live.hsslive.cn](https://live.hsslive.cn) - 线上地址
 
 <div>
   <video
@@ -46,20 +54,52 @@ billd 直播间（前端），目前实现了类似 bilibili 的直播功能，
   ></video>
 </div>
 
-# 安装依赖
+## 准备
+
+- 前端相关：[vue3](https://vuejs.org) 以及相关技术栈
+- 后端相关： [nodejs](https://nodejs.org) 以及相关技术栈、[socket.io](https://socket.io)
+- webrtc 相关： webrtc 相关 api（[RTCPeerConnection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)）、[coturn](https://github.com/coturn/coturn)
+- 流媒体服务器相关： [srs](https://ossrs.net)、 [ffmpeg](https://ffmpeg.org)
+- 数据库相关： mysql、redis
+- docker 相关：[docker](https://www.docker.com)
+
+## 安装和使用
+
+- 获取项目代码
 
 ```bash
-pnpm i
+git clone https://github.com/galaxy-s10/billd-live.git
 ```
 
-# 本地运行
+- 安装依赖
 
 ```bash
-npm run start
+pnpm i
 ```
 
-# billd 依赖
+> 更新 billd 相关依赖：
 
 ```bash
 pnpm i billd-utils@latest billd-scss@latest billd-html-webpack-plugin@latest billd-deploy@latest
 ```
+
+- 运行
+
+```bash
+npm run start
+```
+
+## 赞助
+
+[https://live.hsslive.cn/sponsors](https://live.hsslive.cn/sponsors)
+
+## 交流
+
+如果你对该项目感兴趣或有想法，欢迎进群：
+
+<div>
+  <img
+    src="https://resource.hsslive.cn/image/004ee8afb2e6e725df743d0623dfd801.webp" 
+    style="width:300px"
+    />
+</div>

test.ts

@@ -1,10 +0,0 @@
-const aa = {
-  point_amount: '0.00',
-  receipt_amount: '0.10',
-  send_pay_date: '2023-05-02 05:17:43',
-  trade_no: '2023050222001457971441078831',
-  trade_status: 'TRADE_SUCCESS',
-  created_at: '2023-05-02 05:17:19',
-  updated_at: '2023-05-02 05:18:10',
-  deleted_at: null,
-};