From 17a76e6d7914d1f951d6fc9cff231e2639337870 Mon Sep 17 00:00:00 2001
From: kevin <wanjunfeng@gmail.com>
Date: Thu, 13 Aug 2020 17:20:28 +0800
Subject: [PATCH] add quick start

---
 readme.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 76 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index ce7973d..c4605c0 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,79 @@
-# go-stash项目介绍
+# go-stash
 
 go-stash is a free and open server-side data processing pipeline that ingests data from Kafka, transforms it, and then sends it to ElasticSearch.
 
+## Quick Start
+
+```shell
+gostash -f etc/config.json
+```
+
+config.json looks like:
+
+```json
+{
+    "Input": {
+        "Kafka": {
+            "Name": "gostash",
+            "Brokers": [
+                "172.16.186.16:19092",
+                "172.16.186.17:19092"
+            ],
+            "Topic": "k8slog",
+            "Group": "pro",
+            "NumProducers": 16,
+            "MetricsUrl": "http://localhost:2222/add"
+        }
+    },
+    "Filters": [
+        {
+            "Action": "drop",
+            "Conditions": [
+                {
+                    "Key": "k8s_container_name",
+                    "Value": "-rpc",
+                    "Type": "contains"
+                },
+                {
+                    "Key": "level",
+                    "Value": "info",
+                    "Type": "match",
+                    "Op": "and"
+                }
+            ]
+        },
+        {
+            "Action": "remove_field",
+            "Fields": [
+                "message",
+                "_source",
+                "_type",
+                "_score",
+                "_id",
+                "@version",
+                "topic",
+                "index",
+                "beat",
+                "docker_container",
+                "offset",
+                "prospector",
+                "source",
+                "stream"
+            ]
+        }
+    ],
+    "Output": {
+        "ElasticSearch": {
+            "Hosts": [
+                "172.16.141.4:9200",
+                "172.16.141.5:9200"
+            ],
+            "DailyIndexPrefix": "k8s_pro-"
+        }
+    }
+}
+```
+
+### 微信交流群
+
+添加我的微信：kevwan，请注明go-stash，我拉进go-stash社区群🤝
\ No newline at end of file