Skip to content

Commit 00a8ea2

Browse files
committed
update doc
1 parent f5a3a07 commit 00a8ea2

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.MD

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,29 @@ Usage of ./server:
3737
-listen string
3838
listen address (default ":80")
3939

40-
```
40+
```
41+
42+
# 🧑‍💻 How to use
43+
## On server
44+
```shell
45+
./server -listen=":80"
46+
```
47+
48+
## On client
49+
```shell
50+
./client -listen=":1180" -ws="your_server_ip:80"
51+
```
52+
### 💻 CLI Tool
53+
```shell
54+
export all_proxy=socks5://localhost:1180
55+
curl https://google.com -v
56+
```
57+
### 🐱 Clash
58+
```yaml
59+
proxies:
60+
- name: "wsproxy"
61+
type: socks5
62+
server: localhost
63+
port: 1180
64+
```
65+
> add `wsproxy` to your proxy group

0 commit comments

Comments
 (0)