actions/telegram-action
1
0
Fork 0
mirror of https://github.com/appleboy/telegram-action.git synced 2026-10-03 01:30:44 +09:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve documentation consistency and clarity

Browse Source 
- Fix minor grammatical errors and improve clarity in the README.md
- Capitalize the first letter of list items in the options table for consistency

Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
appleboy
2024-11-20 22:26:53 +08:00
parent 94584eda62
commit 5010c012e9
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -20
View File
@@ -1,6 +1,6 @@
# 🚀 Telegram for GitHub Actions # 🚀 Telegram for GitHub Actions
[GitHub Action](https://github.com/features/actions) for sending a Telegram notification message. [GitHub Action](https://github.com/features/actions) for sending Telegram notification messages.
![notification](./images/telegram-notification.png) ![notification](./images/telegram-notification.png)
@@ -8,9 +8,9 @@
## Usage ## Usage
**NOTE**: If you are getting "Error: Chat not found", then you need to look at this stackoverflow's answer [here](https://stackoverflow.com/a/41291666). **Note**: If you receive the "Error: Chat not found" error, please refer to this StackOverflow answer [here](https://stackoverflow.com/a/41291666).
Send custom message and see the custom variable as below. Send a custom message and view the custom variables below.
```yml ```yml
name: telegram message name: telegram message
@@ -51,25 +51,25 @@ Remove `args` to send the default message.
| Variable | Description | | Variable | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------- | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| socks5 | optional. support socks5 proxy URL | | socks5 | optional. Support socks5 proxy URL |
| photo | optional. photo message | | photo | optional. Photo message |
| document | optional. document message | | document | optional. Document message |
| sticker | optional. sticker message | | sticker | optional. Sticker message |
| audio | optional. audio message | | audio | optional. Audio message |
| voice | optional. voice message | | voice | optional. Voice message |
| location | optional. location message | | location | optional. Location message |
| venue | optional. venue message | | venue | optional. Venue message |
| video | optional. video message | | video | optional. Video message |
| debug | optional. enable debug mode | | debug | optional. Enable debug mode |
| format | optional. `markdown` or `html`. See [MarkdownV2 style](https://core.telegram.org/bots/api#markdownv2-style) | | format | optional. `markdown` or `html`. See [MarkdownV2 style](https://core.telegram.org/bots/api#markdownv2-style) |
| message | optional. custom message | | message | optional. Custom message |
| message_file | optional. overwrite the default message template with the contents of the specified file. | | message_file | optional. Overwrite the default message template with the contents of the specified file. |
| disable_web_page_preview | optional. disables link previews for links in this message. default is `false`. | | disable_web_page_preview | optional. Disables link previews for links in this message. Default is `false`. |
| disable_notification | optional. disables notifications for this message, supports sending a message without notification. default is `false`. | | disable_notification | optional. Disables notifications for this message, supports sending a message without notification. Default is `false`. |
## Example ## Example
send photo message: Send photo message:
```yml ```yml
- uses: actions/checkout@master - uses: actions/checkout@master
@@ -83,7 +83,7 @@ send photo message:
document: tests/gophercolor.png document: tests/gophercolor.png
``` ```
send location message: Send location message:
```yml ```yml
- name: send location message - name: send location message
@@ -95,7 +95,7 @@ send location message:
venue: '35.661777 139.704051 竹北體育館 新竹縣竹北市' venue: '35.661777 139.704051 竹北體育館 新竹縣竹北市'
``` ```
send message using custom proxy (support `http`, `https`, and `socks5`) like `socks5://127.0.0.1:1080` or `http://222.124.154.19:23500` Send message using custom proxy (support `http`, `https`, and `socks5`) like `socks5://127.0.0.1:1080` or `http://222.124.154.19:23500`
```yml ```yml
- name: send message using socks5 proxy URL - name: send message using socks5 proxy URL