From a44d434952bbf916eac9f53e1affa5f08c42689d Mon Sep 17 00:00:00 2001
From: chaoc <liangchao@geedgenetworks.com>
Date: Mon, 14 Aug 2023 11:12:45 +0800
Subject: [PATCH] doc: update readme for add config desc

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ecf783b..b3c5ea6 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,19 @@ flink run -c com.zdjizhi.flink.voip.CorrelateApp path/to/sip-rtp-correlation-<ve
 
 ## 配置项说明
 
-TODO 待补充
+| 配置项                      | 类型                | 必需 | 默认值 | 描述                                                        |
+| --------------------------- | ------------------- | ---------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
+| source.kafka.topic          | STRING              | Y |  | 将要读取的 Kafka Topic 名称，其包含 SIP 和 RTP 原始数据     |
+| source.kafka.props.*        | MAP<STRING, STRING> | Y |  | 将要读取的 Kafka 的 Properties                              |
+| sink.kafka.topic            | STRING              | Y |  | 将合成的 VoIP 及 未关联成功的 RTP 数据写出的 Kafka Topic 名 |
+| sink.kafka.props.*          | MAP<STRING, STRING> | Y |  | 数据输出的 Kafka 的 Properties                              |
+| error.records.output.enable | STRING              | N | False | 是否开启异常数据的输出 【IP 或 Port 为空】                  |
+| error.sink.kafka.topic      | STRING              | N |      | 异常数据输出到的 Kafka Topic 名                             |
+| error.sink.kafka.props.*    | MAP<STRING, STRING> | N |      | 异常数据输出的 Kafka 的 Properties                          |
+| sip.state.clear.interval.minutes | INT | 1 |      | SIP 单向流关联的窗口大小（单位：分钟） |
+| rtp.state.clear.interval.minutes | INT | 6 |      | SIP 和 RTP 关联的窗口大小（单位：分钟） |
+
+
 
 ## 贡献