From 03be29daba7ef21c7e63987a741abe651a504c5c Mon Sep 17 00:00:00 2001
From: nadoo <287492+nadoo@users.noreply.github.com>
Date: Fri, 4 Dec 2020 12:49:49 +0800
Subject: [PATCH] chore: add schemes section to doc
---
README.md | 34 +++++++++++++++++++---------------
config/README.md | 10 +++++++++-
2 files changed, 28 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index feba922..c2ec68b 100644
--- a/README.md
+++ b/README.md
@@ -149,7 +149,23 @@ glider 0.13.0 usage:
forward strategy, default: rr (default "rr")
-verbose
verbose mode
+```
+
+
+run:
+```bash
+glider -config CONFIGPATH
+```
+```bash
+glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
+```
+
+#### Schemes
+
+click to see details
+
+```bash
Available schemes:
listen: mixed ss socks5 http vless trojan trojanc redir redir6 tcp udp tls ws unix kcp
forward: reject ss socks4 socks5 http ssr ssh vless vmess trojan trojanc tcp udp tls ws unix kcp simple-obfs
@@ -268,29 +284,16 @@ Forwarder option scheme: FORWARD_URL#OPTIONS
vmess://[security:]uuid@host:port?alterID=num#priority=200
vmess://[security:]uuid@host:port?alterID=num#priority=200&interface=192.168.1.99
vmess://[security:]uuid@host:port?alterID=num#priority=200&interface=eth0
-
-Config file format(see `./glider.conf.example` as an example):
- # COMMENT LINE
- KEY=VALUE
- KEY=VALUE
- # KEY equals to command line flag name: listen forward strategy...
```
-run:
-```bash
-glider -config CONFIGPATH
-```
-```bash
-glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
-```
-
-### Examples
+#### Examples
click to see details
+```bash
./glider -config glider.conf
-run glider with specified config file.
@@ -327,6 +330,7 @@ glider -verbose -listen :8443 -forward SCHEME://HOST:PORT
Services:
dhcpd: service=dhcpd,INTERFACE,START_IP,END_IP
e.g.,service=dhcpd,eth1,192.168.50.100,192.168.50.199
+```
diff --git a/config/README.md b/config/README.md
index 7b11d70..2493a17 100644
--- a/config/README.md
+++ b/config/README.md
@@ -4,7 +4,15 @@ Command:
```bash
glider -config glider.conf
```
-Config file, **just use the command line flag name as the key name**:
+Config file, **just use the command line flag name as key name**:
+```bash
+ # COMMENT LINE
+ KEY=VALUE
+ KEY=VALUE
+ # KEY equals to command line flag name: listen forward strategy...
+```
+
+Example:
```bash
### glider config file