タイトルを追加する
This commit is contained in:
parent
66fdf87fc0
commit
72407f2c8d
45
README.md
45
README.md
@ -1,16 +1,47 @@
|
|||||||
# slacksend
|
# slacksend
|
||||||
|
|
||||||
Slackにメッセージを送信する
|
Slackにメッセージを送信するツール
|
||||||
|
|
||||||
|
- [slacksend](#slacksend)
|
||||||
|
- [Environments](#environments)
|
||||||
|
- [Functions](#functions)
|
||||||
|
- [How To Use](#how-to-use)
|
||||||
|
- [Develop](#develop)
|
||||||
|
- [Init](#init)
|
||||||
|
- [Aiuto Docs](#aiuto-docs)
|
||||||
|
- [Markdown](#markdown)
|
||||||
|
- [Webserver](#webserver)
|
||||||
|
|
||||||
|
|
||||||
|
## Environments
|
||||||
|
|
||||||
|
Slack Appで`Incoming Webhook`を有効にする必要があります。
|
||||||
|
|
||||||
|
[Slack App](https://api.slack.com/apps)はこちらからどうぞ
|
||||||
|
|
||||||
|
* 参考記事: https://qiita.com/to3izo/items/c2d16f8b3e52b09e543e
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
* Slackのチャンネルにメッセージを送信する
|
* Slackのチャンネルにメッセージを送信する
|
||||||
* Incoming Webhookに対応
|
* Incoming Webhookに対応
|
||||||
|
* `SLACK_WEBHOOK_URL` : URLを指定する
|
||||||
|
* `--title`: タイトルを設定する
|
||||||
|
* 現在の仕様ではチャンネル設定はできません。
|
||||||
|
* 宛先によりチャンネルを設定します。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Dev
|
## How To Use
|
||||||
|
|
||||||
|
Incoming Webhookでメッセージを送信する場合
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export SLACK_WEBHOOK_URL="https://hooks.slack.com/services/XXX/YYY/ZZZ"
|
||||||
|
slacksend --title "タイトル" "本文を指定してください"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Develop
|
||||||
|
|
||||||
実行
|
実行
|
||||||
|
|
||||||
@ -25,15 +56,15 @@ go run ./cmd/slacksend
|
|||||||
go build -o slacksend ./cmd/slacksend
|
go build -o slacksend ./cmd/slacksend
|
||||||
```
|
```
|
||||||
|
|
||||||
## Init
|
### Init
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
go mod init gitea.pglikers.com/tools/slacksen
|
go mod init gitea.pglikers.com/tools/slacksen
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docs
|
### Aiuto Docs
|
||||||
|
|
||||||
### Markdown
|
#### Markdown
|
||||||
|
|
||||||
`gomarkdoc`のInstallが必要です
|
`gomarkdoc`のInstallが必要です
|
||||||
|
|
||||||
@ -42,7 +73,7 @@ go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
|
|||||||
gomarkdoc ./... > docs/api.md
|
gomarkdoc ./... > docs/api.md
|
||||||
```
|
```
|
||||||
|
|
||||||
### Webserver
|
#### Webserver
|
||||||
|
|
||||||
`pkgsite`のInstallが必要です
|
`pkgsite`のInstallが必要です
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user