Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pufferffish authored Apr 1, 2022
1 parent 00cb3dd commit 2fb865d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 2fb865d

Please sign in to comment.