chore: release 1.0.0-alpha.2

.github/workflows/deploy-manually.yml

@@ -14,14 +14,14 @@ on:
         required: true
       version:
         description: 'Asset version to deploy'
-        default: 'v1.0.0-alpha.1'
+        default: 'v1.0.0-alpha.2'
         required: true
       arch:
         description: 'Asset binary architecture (Rust format)'
         default: 'x86_64-unknown-linux-gnu'
         required: true
       config:
-        description: 'YAML configuration string used by bp'
+        description: 'Config string used by bp --config'
         required: true
 
 jobs:
@@ -33,7 +33,7 @@ jobs:
       PASSWORD: ${{ github.event.inputs.password }}
       VERSION: ${{ github.event.inputs.version }}
       ASSET_FILE: bp-${{ github.event.inputs.version }}.${{ github.event.inputs.arch }}.tar.xz
-      CONFIG_FILE: config.yml
+      CONFIG_FILE: config
       DEPLOY_PATH: /root/.bp/deploy/${{ github.event.inputs.version }}
     steps:
       - name: Download Asset
@@ -44,7 +44,7 @@ jobs:
           file: "${{ env.ASSET_FILE }}"
           target: "${{ env.ASSET_FILE }}"
 
-      - name: Write Config YAML File
+      - name: Write Config File
         run: |
           echo -e "${{ github.event.inputs.config }}" > ${{ env.CONFIG_FILE }}
 
@@ -67,7 +67,7 @@ jobs:
           script: |
             TAR_FILE=${{ env.DEPLOY_PATH }}/${{ env.ASSET_FILE }}
             BIN_FILE=${{ env.DEPLOY_PATH }}/bp
-            CONFIG_FILE=${{ env.DEPLOY_PATH }}/config.yml
+            CONFIG_FILE=${{ env.DEPLOY_PATH }}/${{ env.CONFIG_FILE }}
 
             echo "> Extract $TAR_FILE"
             tar -xf $TAR_FILE -C ${{ env.DEPLOY_PATH }}

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bp"
-version = "1.0.0-alpha.1"
+version = "1.0.0-alpha.2"
 authors = ["Micooz Lee <[email protected]>"]
 description = "bp is a lightweight and efficient proxy written in pure Rust."
 repository = "https://github.com/micooz/bp"

README.md

@@ -15,58 +15,10 @@ Lightweight and efficient proxy written in pure Rust.
 
 ## Usage
 
-Please check -h/--help first.
+Please check -h/--help for more information, or check out [USAGE](USAGE.txt).
 
 ```
 $ bp -h
-bp 1.0.0-alpha.1
-
-Lightweight and efficient proxy written in pure Rust
-
-USAGE:
-    bp [OPTIONS]
-
-OPTIONS:
-    -b, --bind <BIND>
-            local service bind address [default: 127.0.0.1:1080]
-
-    -c, --client
-            run as client
-
-        --config <CONFIG>
-            Configuration file in YAML/JSON format
-
-        --dns-server <DNS_SERVER>
-            DNS server address [default: 8.8.8.8:53]
-
-        --force-dest-addr <FORCE_DEST_ADDR>
-            force all incoming data relay to this destination, usually for testing [default: false]
-
-    -h, --help
-            Print help information
-
-    -k, --key <KEY>
-            symmetric encryption key
-
-    -p, --protocol <PROTOCOL>
-            protocol used by transport layer between client and server, "plain" or "erp" are
-            supported [default: erp]
-
-        --proxy-white-list <PROXY_WHITE_LIST>
-            check white list before proxy, pass a file path
-
-    -s, --server
-            run as server
-
-        --server-bind <SERVER_BIND>
-            bp server bind address, client only. If not set, bp will relay directly
-
-        --udp-over-tcp
-            proxy UDP via TCP, client only. Requires --server-bind to be set if true [default:
-            false]
-
-    -V, --version
-            Print version information
 ```
 
 ## Examples

USAGE.txt

@@ -0,0 +1,51 @@
+bp 1.0.0-alpha.2
+
+Lightweight and efficient proxy written in pure Rust
+
+USAGE:
+    bp [OPTIONS]
+
+OPTIONS:
+    -b, --bind <BIND>
+            local service bind address [default: 127.0.0.1:1080]
+
+    -c, --client
+            run as client
+
+        --config <CONFIG>
+            Configuration file in YAML/JSON format
+
+    -d, --daemonize
+            run as daemon process, unix only
+
+        --dns-server <DNS_SERVER>
+            DNS server address [default: 8.8.8.8:53]
+
+        --force-dest-addr <FORCE_DEST_ADDR>
+            force all incoming data relay to this destination, usually for testing [default: false]
+
+    -h, --help
+            Print help information
+
+    -k, --key <KEY>
+            symmetric encryption key
+
+    -p, --protocol <PROTOCOL>
+            protocol used by transport layer between client and server, "plain" or "erp" are
+            supported [default: erp]
+
+        --proxy-white-list <PROXY_WHITE_LIST>
+            check white list before proxy, pass a file path
+
+    -s, --server
+            run as server
+
+        --server-bind <SERVER_BIND>
+            bp server bind address, client only. If not set, bp will relay directly
+
+        --udp-over-tcp
+            proxy UDP via TCP, client only. Requires --server-bind to be set if true [default:
+            false]
+
+    -V, --version
+            Print version information

bp-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bp-cli"
-version = "1.0.0-alpha.1"
+version = "1.0.0-alpha.2"
 edition = "2021"
 
 [dependencies]

bp-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bp-core"
-version = "1.0.0-alpha.1"
+version = "1.0.0-alpha.2"
 edition = "2021"
 
 [features]

bp-monitor/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bp-monitor"
-version = "1.0.0-alpha.1"
+version = "1.0.0-alpha.2"
 edition = "2021"
 
 [dependencies]

bp-test/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bp-test"
-version = "1.0.0-alpha.0"
+version = "1.0.0-alpha.2"
 authors = ["Micooz Lee <[email protected]>"]
 description = "bp is a lightweight and efficient proxy written in pure Rust."
 repository = "https://github.com/micooz/bp"