mirror of
https://github.com/xjasonlyu/tun2socks.git
synced 2024-12-30 02:37:01 +00:00
Chore: update README
This commit is contained in:
@@ -16,25 +16,30 @@ English | [简体中文](README_ZH.md)
|
||||
|
||||
## Features
|
||||
|
||||
- **Fully support:** IPv4/IPv6/ICMP/TCP/UDP
|
||||
- **Proxy protocol:** HTTP/Socks4/Socks5/Shadowsocks
|
||||
- **Game ready:** optimized UDP transmission
|
||||
- **Pure Go:** no CGO required, stability improved
|
||||
- **Router mode:** forwarding packets in LAN
|
||||
- **TCP/IP stack:** powered by **[gVisor](https://github.com/google/gvisor)**
|
||||
- **High performance:** >2.5Gbps throughput
|
||||
|
||||
## Requirements
|
||||
|
||||
| Target | Minimum | Recommended |
|
||||
| :----- | :-----: | :---------: |
|
||||
| System | Linux MacOS Freebsd OpenBSD Windows | Linux or MacOS |
|
||||
| Memory | >20MB | >128MB |
|
||||
| CPU | ANY | AMD64 or ARM64 |
|
||||
- **Network Support**
|
||||
- Dualstack: `IPv4/IPv6`
|
||||
- Forwarder: `TCP/UDP`
|
||||
- Ping Echo: `ICMP`
|
||||
- **Platform Support**
|
||||
- Linux
|
||||
- MacOS
|
||||
- Windows
|
||||
- FreeBSD
|
||||
- OpenBSD
|
||||
- **Proxy Protocol**
|
||||
- HTTP
|
||||
- Socks4
|
||||
- Socks5
|
||||
- Shadowsocks
|
||||
- **Extra Feature**
|
||||
- Improved stability without CGO
|
||||
- Optimized UDP transmission for game
|
||||
- Performed with >2.5Gbps throughput
|
||||
- TCP/IP stack powered by **[gVisor](https://github.com/google/gvisor)**
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentations and quick start guides can be found at [Github Wiki](https://github.com/xjasonlyu/tun2socks/wiki).
|
||||
Docs and quick start guides can be found at [Github Wiki](https://github.com/xjasonlyu/tun2socks/wiki).
|
||||
|
||||
## Community
|
||||
|
||||
@@ -51,3 +56,8 @@ Welcome and feel free to ask any questions at [Github Discussions](https://githu
|
||||
[GPL-3.0](https://github.com/xjasonlyu/tun2socks/blob/main/LICENSE)
|
||||
|
||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fxjasonlyu%2Ftun2socks?ref=badge_large)
|
||||
|
||||
|
||||
## Stargazers over time
|
||||
|
||||
[](https://starchart.cc/xjasonlyu/tun2socks)
|
||||
|
||||
Reference in New Issue
Block a user