瀏覽代碼

docs: update about build

Yujia Qiao 4 年之前
父節點
當前提交
b4bb02f845
共有 3 個文件被更改,包括 11 次插入2 次删除
  1. 8 1
      Cargo.toml
  2. 2 0
      README.md
  3. 1 1
      docs/build-guide.md

+ 8 - 1
Cargo.toml

@@ -10,11 +10,18 @@ readme = "README.md"
 build = "build.rs"
 
 [features]
-default = ["server", "client", "tls", "noise", "notify"]
+default = ["server", "client", "tls", "noise", "hot-reload"]
+
+# Run as a server
 server = []
+# Run as a client
 client = []
+# TLS support
 tls = ["tokio-native-tls"]
+# Noise support
 noise = ["snowstorm", "base64"]
+# Configuration hot-reload support
+hot-reload = ["notify"]
 
 # Feature to enable tokio-console. Disabled by default.
 # Don't enable it unless for debugging purposes.

+ 2 - 0
README.md

@@ -16,6 +16,8 @@ rathole, like [frp](https://github.com/fatedier/frp) and [ngrok](https://github.
 
 ## Quickstart
 
+A full-powered `rathole` can be obtained from the [release](https://github.com/rapiz1/rathole/releases) page. Or [build from source](docs/build-guide.md) for other platforms and customizing the binary.
+
 To use rathole, you need a server with a public IP, and a device behind the NAT, where some services that need to be exposed to the Internet. 
 
 Assuming you have a NAS at home behind the NAT, and want to expose its ssh service to the Internet:

+ 1 - 1
docs/build-guide.md

@@ -8,7 +8,7 @@ cargo build --release
 ```
 
 ## Customize the build
-`rathole` comes with lots of *crate features* that determine whether a certain feature will be compiled or not. Supported features can be checked out in `Cargo.toml`.
+`rathole` comes with lots of *crate features* that determine whether a certain feature will be compiled or not. Supported features can be checked out in `[features]` of [Cargo.toml](../Cargo.toml).
 
 For example, to build `rathole` with the `client` and `noise` feature:
 ```