Skip to content

Commit

Permalink
Chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xjasonlyu committed Feb 10, 2021
1 parent 96e0c8c commit 708b7b2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 12 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ English | [简体中文](README_ZH.md)
## Features

- ICMP echoing / IPv6 support / Socks5 & SS proxy
- `SO_BINDTODEVICE` & `SO_MARK` option support
- Optimized UDP transmission for game acceleration
- Pure Go implementation, no more CGO required
- Router mode, routing all the traffic in LAN
- TCP/IP stack powered by [gVisor](https://github.com/google/gvisor)
- More than 2.5Gbps throughput (10x faster than [v1](https://github.com/xjasonlyu/tun2socks/tree/v1))
- TCP/IP stack powered by *[gVisor](https://github.com/google/gvisor)*
- More than *2.5Gbps* throughput (10x faster than [v1](https://github.com/xjasonlyu/tun2socks/tree/v1))

## Requirements

Expand Down Expand Up @@ -72,10 +73,3 @@ make all-arch
- [google/gvisor](https://github.com/google/gvisor)
- [majek/slirpnetstack](https://github.com/majek/slirpnetstack)
- [WireGuard/wireguard-go](https://git.zx2c4.com/wireguard-go)

## TODO

- [x] Windows support
- [x] FreeBSD support
- [x] OpenBSD support
- [ ] Auto route mode
7 changes: 4 additions & 3 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@
## 特性介绍

- ICMP 回应 / IPv6 支持 / Socks5 和 SS 代理支持
- `SO_BINDTODEVICE` & `SO_MARK` 套接字选项支持
- 适用于游戏加速,针对UDP流量传输的专门优化
- 纯 Go 实现,不再需要 CGO,提升了稳定性
- 路由模式,可以用来转发及代理局域网内所有流量
- 核心由 [gVisor](https://github.com/google/gvisor) 强力驱动的 TCP/IP 网络栈
- 超过 2.5Gbps 的带宽吞吐量([v1](https://github.com/xjasonlyu/tun2socks/tree/v1) 版本的10x倍以上)
- 核心由 *[gVisor](https://github.com/google/gvisor)* 强力驱动的 TCP/IP 网络栈
- 超过 *2.5Gbps* 的带宽吞吐量([v1](https://github.com/xjasonlyu/tun2socks/tree/v1) 版本的10x倍以上)

## 硬件需求

Expand Down Expand Up @@ -93,4 +94,4 @@ make all-arch
- [x] Windows 支持
- [x] FreeBSD 支持
- [x] OpenBSD 支持
- [ ] 自动路由模式
- [ ] ~~自动路由模式~~

0 comments on commit 708b7b2

Please sign in to comment.