From c8c08cfeea01e38af3ae1b93329d3be8659fff46 Mon Sep 17 00:00:00 2001 From: Jason Lyu Date: Wed, 21 Aug 2024 05:27:56 +0800 Subject: [PATCH] Chore: adjust markdown layout (#388) --- .github/CODE_OF_CONDUCT.md | 2 +- .github/FUNDING.yml | 2 +- .github/SECURITY.md | 25 +++++++++++++------------ README.md | 7 ++++--- 4 files changed, 19 insertions(+), 17 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 0e7941a8..80609cf5 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an +standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 2270a970..718c4431 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,6 +1,6 @@ # These are supported funding model platforms -github: [xjasonlyu] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +github: [ xjasonlyu ] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] patreon: # Replace with a single Patreon username open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 2069e2b9..7dec8f24 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -2,27 +2,28 @@ ## Supported Versions -| Version | Supported | -| :-----: | :----------------: | +| Version | Supported | +|:-------:|:------------------:| | 2.x | :white_check_mark: | -| 1.x | :x: | +| 1.x | :x: | ## Reporting a Vulnerability -If you believe you have found a security vulnerability in this repository, please report it to me through coordinated disclosure. +If you believe you have found a security vulnerability in this repository, please report it to me through coordinated +disclosure. **Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** -Instead, please send an email to xjasonlyu[@]gmail.com. +Instead, please email to xjasonlyu[@]gmail.com. Please include as much of the information listed below as you can to help me better understand and resolve the issue: - * The type of issue (e.g., buffer overflow, payload attack) - * Full paths of source file(s) related to the manifestation of the issue - * The location of the affected source code (tag/branch/commit or direct URL) - * Any special configuration required to reproduce the issue - * Step-by-step instructions to reproduce the issue - * Proof-of-concept or exploit code (if possible) - * Impact of the issue, including how an attacker might exploit the issue +* The type of issue (e.g., buffer overflow, payload attack) +* Full paths of source file(s) related to the manifestation of the issue +* The location of the affected source code (tag/branch/commit or direct URL) +* Any special configuration required to reproduce the issue +* Step-by-step instructions to reproduce the issue +* Proof-of-concept or exploit code (if possible) +* Impact of the issue, including how an attacker might exploit the issue This information will help me triage your report more quickly. diff --git a/README.md b/README.md index 7586ffda..92c7d038 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,16 @@ ## Features - Proxy Everything: Handle all network traffic of any internet programs sent by the device through a proxy. -- Proxy Protocols: HTTP/Socks4/Socks5/Shadowsocks/Relay with authentication support for remote connections. -- Run Everywhere: Linux/macOS/Windows/FreeBSD/OpenBSD multi-platform support with specific optimizations. +- Proxy Protocols: HTTP/Socks4/Socks5/Shadowsocks with authentication support for remote connections. +- Run Everywhere: Linux/macOS/Windows/FreeBSD/OpenBSD multi-platform support with specific optimization. - Gateway Mode: Act as a Layer 3 gateway to handle network traffic from other devices on the same network. - Full IPv6 Support: All functions work in IPv6, tunnel IPv4 connections through IPv6 proxy and vice versa. - Network Stack: Powered by the user-space TCP/IP stack from Google container application kernel **[gVisor](https://github.com/google/gvisor)**. ## Benchmarks -For all scenarios of usage, tun2socks performs best. See [benchmarks](https://github.com/xjasonlyu/tun2socks/wiki/Benchmarks) for more details. +For all scenarios of usage, tun2socks performs best. +See [benchmarks](https://github.com/xjasonlyu/tun2socks/wiki/Benchmarks) for more details. ![benchmark](docs/benchmark.png)