Skip to content

Commit bc0bca5

Browse files
committed
Update README
1 parent fc0c0b9 commit bc0bca5

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# sshproxy
2-
sshproxy
2+
3+
SSH Proxy server and client
4+
5+
[![Build](https://github.com/wzshiming/sshproxy/actions/workflows/go-cross-build.yml/badge.svg)](https://github.com/wzshiming/sshproxy/actions/workflows/go-cross-build.yml)
6+
[![Go Report Card](https://goreportcard.com/badge/github.com/wzshiming/sshproxy)](https://goreportcard.com/report/github.com/wzshiming/sshproxy)
7+
[![GoDoc](https://godoc.org/github.com/wzshiming/sshproxy?status.svg)](https://godoc.org/github.com/wzshiming/sshproxy)
8+
[![GitHub license](https://img.shields.io/github/license/wzshiming/sshproxy.svg)](https://github.com/wzshiming/sshproxy/blob/master/LICENSE)
9+
[![gocover.io](https://gocover.io/_badge/github.com/wzshiming/sshproxy)](https://gocover.io/github.com/wzshiming/sshproxy)
10+
11+
This project is to add protocol support for the [Bridge](https://github.com/wzshiming/bridge), or it can be used alone
12+
13+
The following is the implementation of other proxy protocols
14+
15+
- [Socks4](https://github.com/wzshiming/socks4)
16+
- [Socks5](https://github.com/wzshiming/socks5)
17+
- [HTTP Proxy](https://github.com/wzshiming/httpproxy)
18+
- [Shadow Socks](https://github.com/wzshiming/shadowsocks)
19+
20+
## Usage
21+
22+
[API Documentation](https://godoc.org/github.com/wzshiming/sshproxy)
23+
24+
[Example](https://github.com/wzshiming/sshproxy/blob/master/cmd/sshproxy/main.go)
25+
26+
## License
27+
28+
Licensed under the MIT License. See [LICENSE](https://github.com/wzshiming/sshproxy/blob/master/LICENSE) for the full license text.

0 commit comments

Comments
 (0)