Merge branch 'rickyhuo.fea.readMe'

README.md

@@ -1,15 +1,55 @@
-# hangout-output-plugins-clickhouse
+## Hangout output plugin : Clickhouse
 
-> hangout-out-plugins-clickhouse base on hangout-0.3.0
+* Author: rickyHuo
+* Homepage: https://github.com/RickyHuo/hangout-output-clickhouse
+* Version: 1.0.0
 
-## Usage
+### Description
 
+使用Hangout将数据清洗写入ClickHouse
 
+### Options
 
+| name | type | required | default value |
+| --- | --- | --- | --- |
+| [host](#host-string) | string | yes | - |
+| [database](#database-string) | string | yes | - |
+| [table](#table-string) | string | yes | - |
+| [fields](#fields-list) | list | yes | - |
+| [bulk_size](#bulk_size-list) | int | no | 1000 |
+| [replace_include_fields](#replace_include_fields-list) | list | no | - |
+| [replace_exclude_fields](#replace_exclude_fields-list) | list | no | - |
 
-1. 将打包好的jar包(hangout-filters-reverse-0.1.jar)放到hangout的modules文件夹下
+##### host [string]
+
+ClickHouse cluster host
+
+##### database [string]
+
+database
+
+##### table [string]
+
+table
+
+##### fields [list]
+
+table fields， 必须和Hangout清洗后的字段保持一致
+
+##### bulk_size [string]
+
+批次写入量，默认为1000
+
+##### replace_include_fields [list]
+
+需要执行替换'字符操作的字段列表
+
+##### replace_exclude_fields [list]
+
+不需要执行替换'字符操作的字段列表
+
+### Examples
 
-2.
 ```
 outputs:
     - com.sina.bip.hangout.outputs.Clickhouse:
@@ -20,9 +60,5 @@ outputs:
         bulk_size: 500
 ```
 
+> 讲fields中对应的字段写入ClickHouse
 
-## Reference
-
-> [hangout](https://github.com/childe/hangout)
-
-> [hangout-filter-reverse](https://github.com/childe/hangout-filter-reverse)