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 Jul 3, 2024
1 parent c46e75e commit e6d2a9d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
16 changes: 13 additions & 3 deletions README_cn.md → README-ZH_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,16 @@

👉**立即体验:[EasyTransfer](https://file.ch3nyang.top/)**

EasyTransfer是一个免费、简单、易用的 P2P 文件传输工具。您仅需要访问一个简单的网页,就可以使用设备代码连接到**任何网络**中的**任何设备**
EasyTransfer 是一款免费、匿名、加密(*TODO*)且易于使用的 E2EE 文件传输工具。您只需访问一个简单的网页,即可使用设备代码连接到**任何网络**中的**任何设备**

它使用 webRTC 构建,**无需扫码****无需分享 URL 链接****无需上传文件到服务器**
它使用 webRTC 和 Vue.js 构建,并且

- **无需**安装任何软件
- **无需**注册账户
- **无需**扫描二维码
- **无需**分享 URL 链接
- **无需**上传文件到服务器[^1]
- **无需**担心网络环境

## 使用方法

Expand All @@ -33,9 +40,12 @@ EasyTransfer是一个免费、简单、易用的 P2P 文件传输工具。您仅
- [x] 支持拍照传输
- [x] 支持纯文本传输
- [ ] 支持断点续传
- [ ] 加密传输
- [ ] 支持加密传输
- [ ] 支持多设备

## 致谢

- 感谢 [metered](https://www.metered.ca/) 提供免费的 STUN 和 TURN 服务器。
- 感谢 [glitch](https://glitch.com/) 提供了免费的信令服务器。

[^1]: 在通信双方需要内网穿透时,文件可能会上传到本项目提供的免费 TURN 服务器。您可以自行部署一个可信的 TURN 服务器来避免这种情况。
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# EasyTransfer

[简体中文](README_cn.md) | English
[简体中文](README-ZH_cn.md) | English

👉**EXPERIENCE NOW: [EasyTransfer](https://file.ch3nyang.top/)**

EasyTransfer is a free, simple, and easy-to-use P2P file transfer tool. You only need to visit a simple web page to connect to **any device** in **any network** using a device code.
EasyTransfer is a free, anonymous, encrypted (*TODO*), and easy-to-use E2EE file transfer tool. You only need to visit a simple web page to connect to **any device** in **any network** using a device code.

It is built using webRTC, **no need to scan codes**, **no need to share URL links**, **no need to upload files to the server**.
It is built using webRTC and Vue.js, and there is

- **NO** need to install any software
- **NO** need to register an account
- **NO** need to scan QR codes
- **NO** need to share URL links
- **NO** need to upload files to the server[^1]
- **NO** need to worry about the network environment

## How to use

Expand All @@ -33,9 +40,12 @@ It is built using webRTC, **no need to scan codes**, **no need to share URL link
- [x] Support photo transmission
- [x] Support plain text transmission
- [ ] Support breakpoint resume
- [ ] Encrypted transmission
- [ ] Support Encrypted transmission
- [ ] Support multiple devices

## Acknowledgements

- Thanks to [metered](https://www.metered.ca/) for providing free STUN and TURN servers.
- Thanks to [glitch](https://glitch.com/) for providing free signaling servers.

[^1]: If the communicating peers need to penetrate the intranet, the file may be uploaded to the free TURN server provided by this project. You can avoid this by deploying a trusted TURN server yourself.

0 comments on commit e6d2a9d

Please sign in to comment.