From f623c4f9c3a6035645a92d3c6d9e65633d54c3db Mon Sep 17 00:00:00 2001
From: Jay <jay@lawsnote.com>
Date: Sun, 13 Jun 2021 23:03:52 +0800
Subject: [PATCH] [feat] add readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 4b118dd..85fd27a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
 # auto-deploy-service
 
+## Config struct
+
+```yaml
+server:
+  port: 10230 # server listen port
+listens:
+  - http:
+      method: get # http method only support get and post
+      path: /test # http register path
+      headers: # header check map[string]string 
+        x-validate-key: '123'
+      script: /tmp/run.sh # script location required execute permission
+  - http:
+      method: post
+      path: /test-post
+      headers: {}
+      script: /tmp/run.sh
+```