mirrors/wireproxy
1
0
Fork 0
mirror of https://github.com/whyvl/wireproxy.git synced 2025-04-29 19:01:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
octeep 2022-04-01 01:07:50 +01:00 • committed by GitHub
parent 289cfeea8b
commit ba4fe58b50
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,4 +1,8 @@
# wireproxy # 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. A wireguard client that exposes itself as a socks5 proxy or tunnels.
# What is this # What is this
@ -20,6 +24,10 @@ anything.
- TCP static routing for client and server - TCP static routing for client and server
- SOCKS5 proxy (currently only CONNECT is supported) - SOCKS5 proxy (currently only CONNECT is supported)
# TODO
- UDP Support in SOCKS5
- UDP static routing
# Usage # Usage
``` ```
./wireproxy -c [path to config] ./wireproxy -c [path to config]
@ -108,6 +116,9 @@ WGConfig = <path to the wireguard config>
... ...
``` ```
## Donation
<noscript><a href="https://liberapay.com/octeep/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
## Stargazers over time ## Stargazers over time