From 3e68555e12fe80f9587e8c965f8164ed11fcbb8b Mon Sep 17 00:00:00 2001 From: Bear Su Date: Tue, 12 Jul 2022 10:17:25 +0800 Subject: [PATCH] docs(readme): refine document --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 11697e2..e005ce5 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,9 @@ Support channels: - Slack - Discord -Pre-build container image on [Releases](https://github.com/timfanda35/simple-channel-notify/pkgs/container/simple-channel-notify%2Fsimple-channel-notify) +Pre-build container image on [Releases](https://github.com/timfanda35/simple-channel-notify/pkgs/container/simple-channel-notify) +Repository: `ghcr.io/timfanda35/simple-channel-notify` ## Build Build container image @@ -30,6 +31,10 @@ docker run \ simple-channel-notify telegram --message="Notify Message~~~" ``` +Environment Variables +- NOTIFY_TELEGRAM_TOKEN +- NOTIFY_TELEGRAM_CHAT_ID + References: - [從零開始的 Telegram Bot](https://blog.sean.taipei/2017/05/telegram-bot) @@ -45,6 +50,9 @@ docker run \ simple-channel-notify linenotify --message="Notify Message~~~" ``` +Environment Variables +- NOTIFY_LINE_NOTIFY_TOKEN + References: - [LINE Notify API Document](https://notify-bot.line.me/doc/en/) @@ -60,6 +68,9 @@ docker run \ simple-channel-notify hangoutschat --message="Notify Message~~~" ``` +Environment Variables +- NOTIFY_HANGOUTS_CHAT_WEBHOOK + References: - [Using incoming webhooks](https://developers.google.com/hangouts/chat/how-tos/webhooks) @@ -88,6 +99,9 @@ docker run \ simple-channel-notify discord --message="Notify Message~~~" ``` +Environment Variables +- NOTIFY_DISCORD_WEBHOOK + References: - [Webhook Resource](https://discord.com/developers/docs/resources/webhook#execute-webhook) @@ -103,7 +117,7 @@ stages: notify-telegram: stage: run image: - name: 'ghcr.io/timfanda35/simple-channel-notify/simple-channel-notify' + name: 'ghcr.io/timfanda35/simple-channel-notify' entrypoint: [""] script: - /app telegram --message="Message from GitLab CI" @@ -115,7 +129,7 @@ notify-telegram: ``` steps: - - name: 'ghcr.io/timfanda35/simple-channel-notify/simple-channel-notify' + - name: 'ghcr.io/timfanda35/simple-channel-notify' args: [ 'telegram', '--message=Message from Cloud Build' ] env: - 'NOTIFY_TELEGRAM_TOKEN=${_NOTIFY_TELEGRAM_TOKEN}'