From 72407f2c8db19511cc60c62d015722001833566e Mon Sep 17 00:00:00 2001
From: "ry.yamafuji" <ry.yamafuji@gmail.com>
Date: Wed, 24 Dec 2025 22:36:06 +0900
Subject: [PATCH] =?UTF-8?q?=E3=82=BF=E3=82=A4=E3=83=88=E3=83=AB=E3=82=92?=
 =?UTF-8?q?=E8=BF=BD=E5=8A=A0=E3=81=99=E3=82=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 38 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index b03ae1a..60818d0 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,47 @@
 # 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
 
 * Slackのチャンネルにメッセージを送信する
   * 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
 ```
 
-## Init
+### Init
 
 ```sh
 go mod init gitea.pglikers.com/tools/slacksen
 ```
 
-## Docs
+### Aiuto Docs
 
-### Markdown
+#### Markdown
 
 `gomarkdoc`のInstallが必要です
 
@@ -42,7 +73,7 @@ go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
 gomarkdoc ./... > docs/api.md
 ```
 
-### Webserver
+#### Webserver
 
 `pkgsite`のInstallが必要です