Skip to content

Commit 329ad52

Browse files
zxtzxt
authored andcommitted
update readme
1 parent f97fa3c commit 329ad52

5 files changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Pangolin
1+
# ![logo](imgs/logo.png?raw=true) Pangolin
22

33
Pangolin is a Go implenmentation of VPN.
44
* Support TCP/UDP/[PTCP](https://github.com/xitongsys/ptcp) connection. (I suggest PTCP, which has the same performance with UDP and avoid some UDP issues)
@@ -9,9 +9,7 @@ Pangolin is a Go implenmentation of VPN.
99
## Server
1010
Pangolin server can only run natively on Linux. But you can use docker to run it on Windows and Mac.
1111

12-
* Download the latest release package.
13-
14-
* ```cd pangolin_linux/```
12+
* Download the latest release package and ```cd pangolin_linux/```
1513

1614
* Change the environment variables in start.sh to your own.
1715

@@ -22,15 +20,12 @@ TOKENS='["token01", "token02"]'
2220
ROLE=SERVER
2321
```
2422

25-
* Start the pangolin server.
26-
```bash
27-
bash start.sh
28-
```
23+
* Start the pangolin server: ```bash start.sh```
2924

3025
## Client
3126

3227
### Linux
33-
Same steps with the server. But change the ```ROLE``` to ```CLIENT```.
28+
Same steps with the server. But ```ROLE=CLIENT```.
3429
```bash
3530
SERVERIP=your.server.ip.address
3631
SERVERPORT=12345
@@ -41,9 +36,13 @@ ROLE=CLIENT
4136
### Windows
4237
* [Windows Client](https://github.com/xitongsys/pangolin-win)
4338

39+
![Windows Client](imgs/win.png?raw=true)
40+
4441
### Android
4542
* [Android Client](https://github.com/xitongsys/pangolin-android)
4643

44+
![Android Client](imgs/android.png?raw=true)
45+
4746
## Docker
4847

4948
### Build
@@ -58,10 +57,10 @@ TOKENS='["token01", "token02"]'
5857
ROLE="SERVER"
5958
```
6059

61-
* Build ```bash pangolin_docker.sh build```
60+
* Build: ```bash pangolin_docker.sh build```
6261

6362

64-
### Run/Stop
63+
### Start/Stop
6564
```bash
6665
bash pangolin_docker.sh start
6766
bash pangolin_docker.sh stop

imgs/android.png

18.6 KB
Loading

imgs/logo.png

2.23 KB
Loading

imgs/main.jpg

-49.1 KB
Binary file not shown.

imgs/win.png

7.89 KB
Loading

0 commit comments

Comments
 (0)