From d2b8bbeaa8c01481253f7f7ff8fbeaa27eef4b93 Mon Sep 17 00:00:00 2001 From: Datong Sun Date: Sun, 19 Sep 2021 03:01:37 -0700 Subject: [PATCH] docs(readme) add better styling for `MAX_OF_16` --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b0fa306..eb8ef69 100644 --- a/README.md +++ b/README.md @@ -158,16 +158,16 @@ of obfuscation. For people who use Phantun to tunnel WireGuard UDP packets, here are some guidelines on figuring out the correct MTU to use for your WireGuard interface. -WireGuard MTU = MAX\_OF\_16(Interface MTU - IP header (20 bytes) - TCP header (20 bytes) - WireGuard overhead (32 bytes)) +WireGuard MTU = `MAX_OF_16`(Interface MTU - IP header (20 bytes) - TCP header (20 bytes) - WireGuard overhead (32 bytes)) Where: -MAX\_OF\_16 takes an input integer and calculates the maximum multiple of 16 not exceeding the input. This +`MAX_OF_16` takes an input integer and calculates the maximum multiple of 16 not exceeding the input. This is needed because WireGuard will always pad it's payloads to multiple of 16 bytes. For example, for a Ethernet interface with 1500 bytes MTU, the WireGuard interface MTU should be set as: -MAX\_OF\_16(1500 - 20 - 20 - 32) = 1424 bytes +`MAX_OF_16`(1500 - 20 - 20 - 32) = 1424 bytes The resulted Phantun TCP data packet will be 1424 + 20 + 20 + 32 = 1496 bytes which does not exceed the interface MTU of 1500.