From 2fb865da94b8ac4104e413cacf5a02f4b1c0834c Mon Sep 17 00:00:00 2001 From: octeep Date: Fri, 1 Apr 2022 01:07:50 +0100 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4ee59ed..d2df614 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ # wireproxy +[![ISC licensed](https://img.shields.io/badge/license-ISC-blue)](./LICENSE) +[![Build status](https://github.com/octeep/wireproxy/actions/workflows/build.yml/badge.svg)](https://github.com/octeep/wireproxy/actions) +[![Documentation](https://img.shields.io/badge/godoc-wireproxy-blue)](https://pkg.go.dev/github.com/octeep/wireproxy) + A wireguard client that exposes itself as a socks5 proxy or tunnels. # What is this @@ -20,6 +24,10 @@ anything. - TCP static routing for client and server - SOCKS5 proxy (currently only CONNECT is supported) +# TODO +- UDP Support in SOCKS5 +- UDP static routing + # Usage ``` ./wireproxy -c [path to config] @@ -108,6 +116,9 @@ WGConfig = ... ``` +## Donation + + ## Stargazers over time