From e5dd79794bef222a6720beb2a998f2235589ff8c Mon Sep 17 00:00:00 2001
From: tangyanbiao <tangyanbiao@xeno.com>
Date: Fri, 15 Oct 2021 16:01:14 +0800
Subject: [PATCH] doc: update README

---
 .env.example | 1 +
 .gitignore   | 2 +-
 README.md    | 8 ++++++++
 3 files changed, 10 insertions(+), 1 deletion(-)
 create mode 100644 .env.example
 create mode 100644 README.md

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..01dd99e
--- /dev/null
+++ b/.env.example
@@ -0,0 +1 @@
+WEBHOOK_URL=飞书群机器人 webhook 地址
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 88596c0..bd04dd6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,3 @@
 .vercel
 node_modules
-.env.*
\ No newline at end of file
+.env.local
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b1adb6e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# 腾讯兔小巢 Webhooks
+接入飞书群机器人到腾讯兔小巢，当有新反馈时自动推送消息到飞书群机器人
+
+## 如何使用
+- 在飞书新建一个群机器人，复制群机器人的 webhook 地址，详情见 [飞书开放平台·自定义机器人指南](https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN)
+- 将 `.env.example` 重命名为 `.env.local`，`WEBHOOK_URL`修改为你自己的群机器人 webhook 地址
+- 点击右侧按钮一键部署到 Vercel [![Deploy](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/tyanbiao/txc-webhooks.git)
+- 在腾讯兔小巢中配置 Webhooks，`${your domain}/hooks/${product name}`，参考 [腾讯兔小巢·配置 Webhooks](https://txc.qq.com/helper/webHookGuide)