doc(config): describe config file

lighkLife · May 31, 2022 · 79e3e40 · 79e3e40
1 parent ab38e5c
commit 79e3e40
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,9 @@ A simple tcp proxy service.
 
 ![rs-proxy](./doc/rs-proxy.png)
 
+## Why rs-proxy
+`Smaller, faster and more convenient. Save your "memory"!`
+
 ## Usage
 
 ```shell
@@ -19,6 +22,19 @@ OPTIONS:
     -V, --version            Print version information
 
 ```
+## Config
+```toml
+[[proxy]]
+name = "example1" 
+listen = 21883
+target = "127.0.0.1:1883"
+
+[[proxy]]
+enable = false # Optional, default true, set false to ignore current proxy
+name = "example2"
+listen = 22883
+target = "127.0.0.1:2883"
+```
 
 ## Examples
 Communication across network segments.