docs:fix description of Options (#5)

* docs:optimize readme * docs:fix description of Options * docs:optimize Options
kitex-contrib · Dec 3, 2023 · ee1fe89 · ee1fe89
1 parent f07bbd5
commit ee1fe89
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -132,11 +132,13 @@ type Key struct {
 
 | Variable Name    | Default Value                                               | Introduction                                                                                                                                                                                    |
 |------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Address          | 127.0.0.1                                                   | Etcd server address                                                                                                                                                                             |
-| Port             | 2379                                                        | Etcd server port                                                                                                                                                                                |
+| Node             | 127.0.0.1:2379                                              | Etcd server nodes                                                                                                                                                                               |
 | Prefix           | /KitexConfig                                                | The prefix of Etcd                                                                                                                                                                              |
 | ClientPathFormat | {{.ClientServiceName}}/{{.ServerServiceName}}/{{.Category}} | Use go [template](https://pkg.go.dev/text/template) syntax rendering to generate the appropriate ID, and use `ClientServiceName` `ServiceName` `Category` three metadata that can be customised |
 | ServerPathFormat | {{.ServerServiceName}}/{{.Category}}                        | Use go [template](https://pkg.go.dev/text/template) syntax rendering to generate the appropriate ID, and use `ServiceName` `Category` two metadatas that can be customised                      |
+| Timeout          | 5 * time.Second                                             | five seconds timeout                                                                                                                                                                            |
+| LoggerConfig     | NULL                                                        | Default Logger                                                                                                                                                                                  |
+| ConfigParser     | defaultConfigParser                                         | The default is the parser that parses json                                                                                                                                                      |
 
 #### Governance Policy
 > The configPath and configPrefix in the following example use default values, the service name is `ServiceName` and the client name is `ClientName`.

diff --git a/README_CN.md b/README_CN.md
@@ -132,11 +132,13 @@ type Key struct {
 
 | 参数               | 变量默认值                                                       | 作用                                                                                                                     |
 |------------------|-------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
-| Address          | 127.0.0.1                                                   | Etcd 服务器地址                                                                                                             |
-| Port             | 2379                                                        | Etcd 服务器端口                                                                                                             |
+| Node             | 127.0.0.1:2379                                              | Etcd 服务器节点                                                                                                             |
 | Prefix           | /KitexConfig                                                | Etcd 中的 prefix                                                                                                         |
 | ClientPathFormat | {{.ClientServiceName}}/{{.ServerServiceName}}/{{.Category}} | 使用 go [template](https://pkg.go.dev/text/template) 语法渲染生成对应的 ID, 使用 `ClientServiceName` `ServiceName` `Category` 三个元数据 |
 | ServerPathFormat | {{.ServerServiceName}}/{{.Category}}                        | 使用 go [template](https://pkg.go.dev/text/template) 语法渲染生成对应的 ID, 使用 `ServiceName` `Category` 两个元数据                     |
+| Timeout          | 5 * time.Second                                             | 五秒超时时间                                                                                                                 |
+| LoggerConfig     | NULL                                                        | 默认日志                                                                                                                   |
+| ConfigParser     | defaultConfigParser                                         | 解析 json 数据的解析器                                                                                                         |
 
 #### 治理策略
 下面例子中的 configPath 以及 configPrefix 均使用默认值，服务名称为 ServiceName，客户端名称为 ClientName