diff --git a/README.md b/README.md index 09c4072..0488844 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Pangolin +# ![logo](imgs/logo.png?raw=true) Pangolin Pangolin is a Go implenmentation of VPN. * 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. ## Server Pangolin server can only run natively on Linux. But you can use docker to run it on Windows and Mac. -* Download the latest release package. - -* ```cd pangolin_linux/``` +* Download the latest release package and ```cd pangolin_linux/``` * Change the environment variables in start.sh to your own. @@ -22,15 +20,12 @@ TOKENS='["token01", "token02"]' ROLE=SERVER ``` -* Start the pangolin server. -```bash -bash start.sh -``` +* Start the pangolin server: ```bash start.sh``` ## Client ### Linux -Same steps with the server. But change the ```ROLE``` to ```CLIENT```. +Same steps with the server. But ```ROLE=CLIENT```. ```bash SERVERIP=your.server.ip.address SERVERPORT=12345 @@ -41,9 +36,13 @@ ROLE=CLIENT ### Windows * [Windows Client](https://github.com/xitongsys/pangolin-win) +![Windows Client](imgs/win.png?raw=true) + ### Android * [Android Client](https://github.com/xitongsys/pangolin-android) +![Android Client](imgs/android.png?raw=true) + ## Docker ### Build @@ -58,10 +57,10 @@ TOKENS='["token01", "token02"]' ROLE="SERVER" ``` -* Build ```bash pangolin_docker.sh build``` +* Build: ```bash pangolin_docker.sh build``` -### Run/Stop +### Start/Stop ```bash bash pangolin_docker.sh start bash pangolin_docker.sh stop diff --git a/imgs/android.png b/imgs/android.png new file mode 100644 index 0000000..1f21e84 Binary files /dev/null and b/imgs/android.png differ diff --git a/imgs/logo.png b/imgs/logo.png new file mode 100644 index 0000000..315a5ce Binary files /dev/null and b/imgs/logo.png differ diff --git a/imgs/main.jpg b/imgs/main.jpg deleted file mode 100644 index bf60bd3..0000000 Binary files a/imgs/main.jpg and /dev/null differ diff --git a/imgs/win.png b/imgs/win.png new file mode 100644 index 0000000..4672393 Binary files /dev/null and b/imgs/win.png differ