doc: update README

2021-10-15 16:01:14 +08:00 · 2021-10-15 16:01:14 +08:00 · e5dd79794b
commit e5dd79794b
parent db12f87216
3 changed files with 10 additions and 1 deletions
--- a/.env.example
+++ b/.env.example
@ -0,0 +1 @@
+WEBHOOK_URL=飞书群机器人 webhook 地址
--- a/.gitignore
+++ b/.gitignore
@ -1,3 +1,3 @@
 .vercel
 node_modules
-.env.*
+.env.local
--- a/README.md
+++ 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)
				`@ -0,0 +1 @@`
				`WEBHOOK_URL=飞书群机器人 webhook 地址`