瀏覽代碼

docs: update README (close #66)

JustSong 2 年之前
父節點
當前提交
4644e02321
共有 1 個文件被更改,包括 21 次插入0 次删除
  1. 21 0
      README.md

+ 21 - 0
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 跳转到本系统所渲染的消息详情实现的。
+
 **示例:**
 
 <details>