feat: update README.md

This commit is contained in:
iamtsm 2025-02-07 12:50:56 +08:00
parent 30ed2d54be
commit 92efa2b408
4 changed files with 139 additions and 11 deletions

27
DISCLAIMER.md Normal file
View File

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

View File

@ -1,27 +1,62 @@
![TL-RTC-APP Logo](web-v2-res/image/tlrtcapp-logo.svg)
<p align="center">
<img src="web-v2-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo">
</p>
### 安装步骤
### Preview
<img src="web-v2-res/image/homepage.png" alt="homepage">
## Prerequisites
1. Install Node.js environment
2. Install MySQL environment
3. Install Redis environment
## Installation Steps
1. Clone the repository:
1. 克隆仓库:
```bash
git clone https://github.com/tl-open-source/tl-rtc-app.git
```
2. 进入项目目录:
2. Navigate to the project directory:
```bash
cd tl-rtc-app
```
3. 安装依赖:
3. Install dependencies:
```bash
npm install
```
### 使用说明
1. 启动应用:
## Usage Instructions
1. Start the application - Api
```bash
npm start
npm run http-api
or
npm run https-api
```
2. 打开浏览器并访问 `http://localhost:9096`。
2. Start the application - Socket
### 许可证
该项目根据 MIT 许可证授权。有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
```bash
npm run http-socket
or
npm run https-socket
```
3. Open your browser and visit `http://localhost:9096`.
## License
This project is licensed under the MIT License. For more details, please refer to the [LICENSE](LICENSE) file.
## Disclaimer
For more details, please refer to the [DISCLAIMER](DISCLAIMER) file.

66
README_ZH.md Normal file
View File

@ -0,0 +1,66 @@
<p align="center">
<img src="web-v2-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo">
</p>
### 预览
<img src="web-v2-res/image/homepage.png" alt="homepage">
### 准备
1. 安装nodejs环境
2. 安装mysql环境
3. 安装redis环境
### 安装步骤
1. 克隆仓库:
```bash
git clone https://github.com/tl-open-source/tl-rtc-app.git
```
2. 进入项目目录:
```bash
cd tl-rtc-app
```
3. 安装依赖:
```bash
npm install
```
### 使用说明
1. 启动应用 - Api
```bash
npm run http-api
或者
npm run https-api
```
2. 启动应用 - Socket
```bash
npm run http-socket
或者
npm run https-socket
```
3. 打开浏览器并访问 `http://localhost:9096`。
### 许可证
该项目根据 MIT 许可证授权。有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
### 免责声明
有关详细信息,请参阅 [DISCLAIMER](DISCLAIMER) 文件。

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB