From d63374b2cad10351419610881189b6af3981a5c6 Mon Sep 17 00:00:00 2001 From: dnomd343 Date: Sat, 5 Feb 2022 14:15:30 +0800 Subject: [PATCH] docs: update README.md --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ebc6686..23b031a 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ A simple program to make the original shadowsocks support SIP003 plugins. --plugin Enable SIP003 plugin. --plugin-opts Set SIP003 plugin options. --shadowsocks Set shadowsocks local or server program. +--no-udp Do not use UDP proxy. -h, --help Print this message. ``` @@ -40,6 +41,7 @@ You can also run via a JSON config file: "timeout": 300, "method": "aes-256-cfb", "fast_open": false, + "no_udp": false, "plugin": "...", "plugin_opts": "...", "shadowsocks": "...", @@ -58,9 +60,12 @@ shell> ss-bootstrap-local -s 127.0.0.1 -p 12345 -b 0.0.0.0 -l 1080 -k dnomd343 - You need to install `gcc` , `make` and `cmake` at first, and also need the `glib2.0` development environment. -Example on `Alpine`: +
+ +Examples ```bash +# Alpine apk add build-base make cmake git glib-dev git clone https://github.com/dnomd343/shadowsocks-bootstrap.git cd shadowsocks-bootstrap/ @@ -69,9 +74,8 @@ cmake .. && make mv ../bin/* /usr/bin/ ``` -Example on `Ubuntu`: - ```bash +# Ubuntu sudo apt update sudo apt install build-essential cmake git libglib2.0-dev git clone https://github.com/dnomd343/shadowsocks-bootstrap.git @@ -81,9 +85,8 @@ cmake .. && make sudo mv ../bin/* /usr/local/bin/ ``` -Example on `CentOS`: - ```bash +# CentOS sudo yum update sudo yum groupinstall "Development Tools" sudo yum install cmake libgnomeui-devel @@ -94,6 +97,8 @@ cmake .. && make sudo mv ../bin/* /usr/local/bin/ ``` +
+ ### License MIT ©2022 [@dnomd343](https://github.com/dnomd343)