diff --git a/README.md b/README.md index 69694d5..04c6e43 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,17 @@ [简体中文](/README_CN.md) | [English](/README.md) EasyTier is a simple, safe and decentralized VPN networking solution implemented with the Rust language and Tokio framework. + +

+ + +

## Features - **Decentralized**: No need to rely on centralized services, nodes are equal and independent. - **Safe**: Use WireGuard protocol to encrypt data. +- **High Performance**: Full-link zero-copy, with performance comparable to mainstream networking software. - **Cross-platform**: Supports MacOS/Linux/Windows, will support IOS and Android in the future. The executable file is statically linked, making deployment simple. - **Networking without public IP**: Supports networking using shared public nodes, refer to [Configuration Guide](#Networking-without-public-IP) - **NAT traversal**: Supports UDP-based NAT traversal, able to establish stable connections even in complex network environments. @@ -20,13 +26,15 @@ - **Smart Routing**: Selects links based on traffic to reduce latency and increase throughput. - **TCP Support**: Provides reliable data transmission through concurrent TCP links when UDP is limited, optimizing performance. - **High Availability**: Supports multi-path and switches to healthy paths when high packet loss or network errors are detected. +- **IPv6 Support**: Supports networking using IPv6. + ## Installation 1. **Download the precompiled binary file** - Visit the [GitHub Release page](https://github.com/KKRainbow/EasyTier/releases) to download the binary file suitable for your operating system. + Visit the [GitHub Release page](https://github.com/KKRainbow/EasyTier/releases) to download the binary file suitable for your operating system. Release includes both command-line programs and GUI programs in the compressed package. 2. **Install via crates.io** ```sh @@ -39,6 +47,8 @@ ``` ## Quick Start + + > The following text only describes the use of the command-line tool; the GUI program can be configured by referring to the following concepts. Make sure EasyTier is installed according to the [Installation Guide](#Installation), and both easytier-core and easytier-cli commands are available. diff --git a/README_CN.md b/README_CN.md index 38f38fa..e36c184 100644 --- a/README_CN.md +++ b/README_CN.md @@ -9,10 +9,16 @@ 一个简单、安全、去中心化的内网穿透 VPN 组网方案,使用 Rust 语言和 Tokio 框架实现。 +

+ + +

+ ## 特点 - **去中心化**:无需依赖中心化服务,节点平等且独立。 -- **安全**:支持利用 WireGuard 加密通信。 +- **安全**:支持利用 WireGuard 加密通信,也支持 AES-GCM 加密保护中转流量。 +- **高性能**:全链路零拷贝,性能与主流组网软件相当。 - **跨平台**:支持 MacOS/Linux/Windows,未来将支持 IOS 和 Android。可执行文件静态链接,部署简单。 - **无公网 IP 组网**:支持利用共享的公网节点组网,可参考 [配置指南](#无公网IP组网) - **NAT 穿透**:支持基于 UDP 的 NAT 穿透,即使在复杂的网络环境下也能建立稳定的连接。 @@ -20,12 +26,13 @@ - **智能路由**:根据流量智能选择链路,减少延迟,提高吞吐量。 - **TCP 支持**:在 UDP 受限的情况下,通过并发 TCP 链接提供可靠的数据传输,优化性能。 - **高可用性**:支持多路径和在检测到高丢包率或网络错误时切换到健康路径。 +- **IPV6 支持**:支持利用 IPV6 组网。 ## 安装 1. **下载预编译的二进制文件** - 访问 [GitHub Release 页面](https://github.com/KKRainbow/EasyTier/releases) 下载适用于您操作系统的二进制文件。 + 访问 [GitHub Release 页面](https://github.com/KKRainbow/EasyTier/releases) 下载适用于您操作系统的二进制文件。Release 压缩包中同时包含命令行程序和图形界面程序。 2. **通过 crates.io 安装** ```sh @@ -40,6 +47,8 @@ ## 快速开始 +> 下文仅描述命令行工具的使用,图形界面程序可参考下述概念自行配置。 + 确保已按照 [安装指南](#安装) 安装 EasyTier,并且 easytier-core 和 easytier-cli 两个命令都已经可用。 ### 双节点组网 diff --git a/assets/image-4.png b/assets/image-4.png new file mode 100644 index 0000000..46166fa Binary files /dev/null and b/assets/image-4.png differ diff --git a/assets/image-5.png b/assets/image-5.png new file mode 100644 index 0000000..1093ea1 Binary files /dev/null and b/assets/image-5.png differ diff --git a/assets/image-6.png b/assets/image-6.png new file mode 100644 index 0000000..381d1fe Binary files /dev/null and b/assets/image-6.png differ diff --git a/assets/image-7.png b/assets/image-7.png new file mode 100644 index 0000000..c7604b5 Binary files /dev/null and b/assets/image-7.png differ