From bfb7085a88eeb2c15a1b75a2fcc6363fa33a73ac Mon Sep 17 00:00:00 2001 From: xmh0511 <970252187@qq.com> Date: Wed, 27 Nov 2024 10:35:58 +0800 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e7873c4..9cafe72 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,23 @@ Tun/Tap interfaces This crate allows the creation and usage of Tun/Tap interfaces(**supporting both Ipv4 and ipv6**), aiming to make this cross-platform. +## Features: +1. Supporting TUN and TAP(macOS only support TUN) +2. Supporting both IPv4 and IPv6 +3. Supporting Synchronous and Asynchronous API +4. Supporting Tokio and async-std asynchronous runtimes +5. All platforms have consistent IP packets(macOS's 4-byte head information can be eliminated). +6. Experimentally supporting shutdown for Synchronous version +7. Supporting Offload on the Linux platform. + +## Supported Platforms + +- [x] Windows +- [x] Linux +- [x] macOS +- [x] FreeBSD +- [x] Android +- [x] iOS Usage ----- @@ -95,16 +112,7 @@ config 1. [Synchronous example](https://github.com/xmh0511/tun-rs/blob/main/examples/read-offload.rs) 2. [Asynchronous example](https://github.com/xmh0511/tun-rs/blob/main/examples/ping-tun-offload-tokio.rs) -Platforms -========= -## Supported Platforms -- [x] Windows -- [x] Linux -- [x] macOS -- [x] FreeBSD -- [x] Android -- [x] iOS Linux @@ -162,4 +170,4 @@ You need to copy the [wintun.dll](https://wintun.net/) file which matches your a the same directory as your executable and run your program as administrator. #### Tap: -You need to manually install [tap-windows](https://build.openvpn.net/downloads/releases/) that matches your architecture when using tap network interface. +When using the tap network interface, you need to manually install [tap-windows](https://build.openvpn.net/downloads/releases/) that matches your architecture.