Skip to content

Commit 92efa2b

Browse files
committed
feat: update README.md
1 parent 30ed2d5 commit 92efa2b

File tree

4 files changed

+139
-11
lines changed

4 files changed

+139
-11
lines changed

DISCLAIMER.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
# 免责声明
3+
1.1 如使用本演示网站/开源项目,即表示您已同意本条款。我们 (开源项目维护团队) 始终在不断更改和改进我们的服务。我们可能会增加或删除功能,也可能暂停或彻底停止某项服务。您可以随时停止使用我们的服务,我们也可以随时对我们的服务增加新的限制。
4+
5+
1.2 该网站/开源项目的使用者在使用本演示网站/开源项目前,应仔细阅读以下条款并同意遵守。使用本演示网站/开源项目将被视为对本免责协议的接受和遵守。
6+
7+
## 演示网站/开源项目的性质
8+
2.1 本演示网站/开源项目旨在帮助大家学习webrtc,提供一个学习/演示demo环境,和基础功能代码入门教学
9+
10+
2.2 本演示网站/开源项目提供的服务旨在为用户提供数据传输功能演示,包括但不限于文件传输、直播、音视频通话、远程屏幕共享、聊天等功能的演示。
11+
12+
2.3 使用者应理解,本演示网站/开源项目仅提供技术支持演示,不对数据传输的准确性、及时性、完整性、安全性或合法性负责。使用者应自行承担使用本演示网站/开源项目的风险。
13+
14+
## 使用者责任
15+
3.1 使用者应承担使用本演示网站/开源项目的全部责任和风险。对于使用者通过本演示网站/开源项目进行的任何操作、行为或后果,本演示网站/开源项目不承担任何责任。
16+
17+
3.2 使用者不得利用本演示网站/开源项目进行任何违法、侵权、威胁、诽谤、骚扰、破坏性或其他不当行为。若使用者违反上述规定,本演示网站/开源项目有权立即终止或限制使用者的访问权限。
18+
19+
3.3 本演示网站使用者严禁上传违法违规内容,包括但不限于:色情低俗、政治敏感、、暴力、恶意软件、诈骗、贩卖公民隐私,上传上述内容将永久封禁账号或 IP 地址,并可能承担承担刑事责任
20+
21+
## 免责条款
22+
4.1 本演示网站/开源项目不对任何由于使用本演示网站/开源项目而引起的任何直接、间接、附带、特殊、惩罚性或后续的损害承担责任,包括但不限于利润损失、商业中断、计算机系统故障、数据丢失或其他经济损失。
23+
24+
4.2 本演示网站/开源项目不对任何第三方通过本演示网站/开源项目发布、提供或传输的任何内容的准确性、合法性、安全性或可靠性负责。
25+
26+
## 免责声明的范围
27+
本免责协议适用于使用本演示网站/开源项目的所有用户,无论其身份或目的。该免责协议的内容适用于因使用本演示网站/开源项目而产生的一切事项,包括但不限于使用本演示网站/开源项目的内容、服务或信息所引起的任何纠纷、损失或损害。

README.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,62 @@
1-
![TL-RTC-APP Logo](web-v2-res/image/tlrtcapp-logo.svg)
1+
<p align="center">
2+
<img src="web-v2-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo">
3+
</p>
24

3-
### 安装步骤
5+
### Preview
6+
7+
<img src="web-v2-res/image/homepage.png" alt="homepage">
8+
9+
## Prerequisites
10+
11+
1. Install Node.js environment
12+
13+
2. Install MySQL environment
14+
15+
3. Install Redis environment
16+
17+
## Installation Steps
18+
19+
1. Clone the repository:
420

5-
1. 克隆仓库:
621
```bash
722
git clone https://github.com/tl-open-source/tl-rtc-app.git
823
```
9-
2. 进入项目目录:
24+
2. Navigate to the project directory:
25+
1026
```bash
1127
cd tl-rtc-app
1228
```
13-
3. 安装依赖:
29+
3. Install dependencies:
30+
1431
```bash
1532
npm install
1633
```
1734

18-
### 使用说明
19-
1. 启动应用:
35+
## Usage Instructions
36+
1. Start the application - Api
37+
2038
```bash
21-
npm start
39+
npm run http-api
40+
41+
or
42+
43+
npm run https-api
2244
```
23-
2. 打开浏览器并访问 `http://localhost:9096`
2445

46+
2. Start the application - Socket
47+
48+
```bash
49+
npm run http-socket
50+
51+
or
52+
53+
npm run https-socket
54+
```
55+
56+
3. Open your browser and visit `http://localhost:9096`.
57+
58+
## License
59+
This project is licensed under the MIT License. For more details, please refer to the [LICENSE](LICENSE) file.
2560

26-
### 许可证
27-
该项目根据 MIT 许可证授权。有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
61+
## Disclaimer
62+
For more details, please refer to the [DISCLAIMER](DISCLAIMER) file.

README_ZH.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<p align="center">
2+
<img src="web-v2-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo">
3+
</p>
4+
5+
### 预览
6+
7+
<img src="web-v2-res/image/homepage.png" alt="homepage">
8+
9+
### 准备
10+
11+
1. 安装nodejs环境
12+
13+
2. 安装mysql环境
14+
15+
3. 安装redis环境
16+
17+
### 安装步骤
18+
19+
1. 克隆仓库:
20+
21+
```bash
22+
git clone https://github.com/tl-open-source/tl-rtc-app.git
23+
```
24+
25+
2. 进入项目目录:
26+
27+
```bash
28+
cd tl-rtc-app
29+
```
30+
31+
3. 安装依赖:
32+
33+
```bash
34+
npm install
35+
```
36+
37+
### 使用说明
38+
1. 启动应用 - Api
39+
40+
```bash
41+
npm run http-api
42+
43+
或者
44+
45+
npm run https-api
46+
```
47+
48+
2. 启动应用 - Socket
49+
50+
```bash
51+
npm run http-socket
52+
53+
或者
54+
55+
npm run https-socket
56+
```
57+
58+
3. 打开浏览器并访问 `http://localhost:9096`
59+
60+
61+
### 许可证
62+
该项目根据 MIT 许可证授权。有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
63+
64+
65+
### 免责声明
66+
有关详细信息,请参阅 [DISCLAIMER](DISCLAIMER) 文件。

web-v2-res/image/homepage.png

32.2 KB
Loading

0 commit comments

Comments
 (0)