update doc

hertz-contrib · Jul 19, 2024 · c92b929 · c92b929
1 parent 8b0854a
commit c92b929
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -111,11 +111,12 @@ func main() {
 }
 ```
 
-| Configuration  | Default                   | Description                  |
-|----------------|---------------------------|------------------------------|
-| `WithDirector` | `nil`                     | customize the forward header |
-| `WithDialer`   | `gorillaws.DefaultDialer` | for dialer customization     |
-| `WithUpgrader` | `hzws.HertzUpgrader`      | for upgrader customization   |
+| Configuration      | Default                   | Description                                                 |
+|--------------------|---------------------------|-------------------------------------------------------------|
+| `WithDirector`     | `nil`                     | customize the forward header                                |
+| `WithDialer`       | `gorillaws.DefaultDialer` | for dialer customization                                    |
+| `WithUpgrader`     | `hzws.HertzUpgrader`      | for upgrader customization                                  |
+| `WithDynamicRoute` | `false`                   | enable dynamic route (proxy url = handler url + target url) |
 
 ### More info
 See [example](https://github.com/cloudwego/hertz-examples)
diff --git a/ws_reverse_proxy_option.go b/ws_reverse_proxy_option.go
@@ -83,7 +83,7 @@ func WithUpgrader(upgrader *hzws.HertzUpgrader) Option {
 }
 
 // WithDynamicRoute enable dynamic route
-// backend url = handler url + proxy url
+// proxy url = handler url + target url
 func WithDynamicRoute() Option {
 	return func(o *Options) {
 		o.DynamicRoute = true