docs:optimize Options

kitex-contrib · Dec 3, 2023 · e955e56 · e955e56
1 parent fceb971
commit e955e56
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -136,6 +136,9 @@ type Key struct {
 | 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
@@ -136,6 +136,9 @@ type Key struct {
 | 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