From dff0c4ca28d0ee2b9835ea27eeffb08ebf88c7aa Mon Sep 17 00:00:00 2001 From: Datong Sun Date: Fri, 8 Apr 2022 21:15:09 -0700 Subject: [PATCH] docs(readme) add link for `fake-tcp` docs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 320bcd2..7c8d89e 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ Table of Contents * [MTU overhead](#mtu-overhead) * [MTU calculation for WireGuard](#mtu-calculation-for-wireguard) * [Version compatibility](#version-compatibility) +* [Documentations](#documentations) * [Performance](#performance) * [Future plans](#future-plans) * [Compariation to udp2raw](#compariation-to-udp2raw) @@ -176,6 +177,8 @@ sudo setcap cap_net_admin=+pe phantun_client **Note:** Run Phantun executable with `-h` option to see full detailed options. +[Back to TOC](#table-of-contents) + ### Server Note: `4567` is the TCP port Phantun should listen on and must corresponds to the DNAT @@ -252,6 +255,13 @@ of Server/Client of Phantun on both ends to ensure maximum compatibility. [Back to TOC](#table-of-contents) +# Documentations + +For users who wish to use `fake-tcp` library inside their own project, refer to the documentations for the library at: +[https://docs.rs/fake-tcp](https://docs.rs/fake-tcp). + +[Back to TOC](#table-of-contents) + # Performance Performance was tested on AWS t3.xlarge instance with 4 vCPUs and 5 Gb/s NIC. WireGuard was used