Skip to content

Commit 2fb865d

Browse files
authored
Update README.md
1 parent 00cb3dd commit 2fb865d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
# wireproxy
2+
[![ISC licensed](https://img.shields.io/badge/license-ISC-blue)](./LICENSE)
3+
[![Build status](https://github.com/octeep/wireproxy/actions/workflows/build.yml/badge.svg)](https://github.com/octeep/wireproxy/actions)
4+
[![Documentation](https://img.shields.io/badge/godoc-wireproxy-blue)](https://pkg.go.dev/github.com/octeep/wireproxy)
5+
26
A wireguard client that exposes itself as a socks5 proxy or tunnels.
37

48
# What is this
@@ -20,6 +24,10 @@ anything.
2024
- TCP static routing for client and server
2125
- SOCKS5 proxy (currently only CONNECT is supported)
2226

27+
# TODO
28+
- UDP Support in SOCKS5
29+
- UDP static routing
30+
2331
# Usage
2432
```
2533
./wireproxy -c [path to config]
@@ -108,6 +116,9 @@ WGConfig = <path to the wireguard config>
108116
...
109117
```
110118

119+
## Donation
120+
<noscript><a href="https://liberapay.com/octeep/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
121+
111122

112123
## Stargazers over time
113124

0 commit comments

Comments
 (0)