Skip to content

Commit

Permalink
doc: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WCY-dt committed Dec 24, 2024
1 parent f235aa6 commit 9e1f784
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 10 deletions.
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

All notable changes to this project will be documented in this file.

## [3.1.10] - 2024-12-24

### Changed

- Only reload when specific settings are changed

### Fixed

- Fixed the CI/CD pipeline to deploy the correct version

## [3.1.9] - 2024-12-23

### Added
Expand Down Expand Up @@ -40,7 +50,7 @@ All notable changes to this project will be documented in this file.

## [3.1.6] - 2024-12-10

## Changed
### Changed

- Refactored the server code from JS to TS to improve the code quality and maintainability
- Improved webpage design
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ It is built using webRTC and Vue.js, and there is
3. After waiting for the connection to succeed, you can drag and drop the file to the file area on the web page, or click the file area to select the file. Supports sending multiple files at once.
4. In the settings, you can customize the STUN server and TURN server, or specify the maximum number of connections.

## Notes

- This project is hosted on a free server. Please do not abuse it.
> [!NOTE]
>
> This project currently uses free STUN/TURN servers, which has a monthly traffic limit. Please do not abuse it. It is recommended that you deploy a STUN/TURN server yourself to obtain faster speed and higher stability.
## Self-deployment

Expand Down
6 changes: 3 additions & 3 deletions README_ZH-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ EasyTransfer 是一款免费、匿名、加密且易于使用的 E2EE 文件传
3. 等待连接成功后,您可以将文件拖放到网页上的文件区域,或者点击文件区域选择文件。支持一次性发送多个文件。
4. 在设置中,可以自定义 STUN 服务器和 TURN 服务器,或者指定最大连接数。

## 注意事项

- 本项目全部托管在免费的服务器上,请不要滥用。
> [!NOTE]
>
> 本项目目前使用了免费的 STUN/TURN 服务器,每月有流量限制,请不要滥用。更推荐您自行部署一个 STUN/TURN 服务器,以获得更快的速度和更高的稳定性
## 自行部署

Expand Down
4 changes: 2 additions & 2 deletions client/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "client",
"version": "3.1.9",
"version": "3.1.10",
"private": true,
"type": "module",
"scripts": {
Expand Down

0 comments on commit 9e1f784

Please sign in to comment.