From 4644e023216d0eb89510b280ba7985c8a5452531 Mon Sep 17 00:00:00 2001 From: JustSong Date: Mon, 8 May 2023 11:18:20 +0800 Subject: [PATCH] docs: update README (close #66) --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 9bf2075..6775239 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,27 @@ proxy_send_timeout 300s; 3. `POST` 请求方式:字段与上面 `GET` 请求方式保持一致。 + 注意:请求体编码格式为 `application/json`,`v0.3.2` 版本起支持 Post Form。 + +**各种通道的支持程度:** + +| 通道类型 | `title` | `description` | `content` | `url` | `to` | Markdown 支持 | +|:----------:|:-------:|:-------------:|:---------:|:-----:|:----:|:-----------:| +| `email` | ✅ | ✅ | ✅ | ❌ | ✅️ | ✅️ | +| `test` | ❌ | ✅ | ✅ | ✅️ | ✅️ | ✅ | +| `corp_app` | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ | +| `corp` | ❌ | ✅ | ✅ | ✅️ | ✅️ | ✅ | +| `lark` | ❌ | ✅ | ✅ | ❌ | ✅ | ✅ | +| `lark_app` | ❌ | ✅ | ✅ | ❌️ | ✅ | ✅ | +| `ding` | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ | +| `bark` | ✅ | ✅ | ✅ | ✅️ | ❌ | ✅ | +| `client` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | +| `telegram` | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ | +| `discord` | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ | + +注意: +1. 对于大部分通道,`description` 字段和 `content` 是不能同时存在的,如果你只需要文字消息,请使用 `description` 字段,如果你需要发送 Markdown 消息,请使用 `content` 字段。 +2. 部分通道的 Markdown 支持实际上是通过 URL 跳转到本系统所渲染的消息详情实现的。 + **示例:**