From 075c3a83caf56f820da2a5b2a1b4e27b04f11050 Mon Sep 17 00:00:00 2001 From: "ry.yamafuji" Date: Wed, 24 Dec 2025 09:07:31 +0900 Subject: [PATCH] =?UTF-8?q?=E9=96=8B=E7=99=BA=E7=92=B0=E5=A2=83=E3=81=AE?= =?UTF-8?q?=E5=AE=9F=E8=A3=85=E5=AE=8C=E4=BA=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 34 ++++++++++++++++++++++++++++++++-- docs/api.md | 13 +++++++++++++ readme/dev.md | 12 ++++++++++++ 3 files changed, 57 insertions(+), 2 deletions(-) create mode 100644 docs/api.md diff --git a/README.md b/README.md index e87f3e1..b03ae1a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ Slackにメッセージを送信する +## Functions + +* Slackのチャンネルにメッセージを送信する + * Incoming Webhookに対応 + + +--- + ## Dev 実行 @@ -12,12 +20,34 @@ go run ./cmd/slacksend ビルド + ```sh go build -o slacksend ./cmd/slacksend ``` -## init +## Init ```sh go mod init gitea.pglikers.com/tools/slacksen -``` \ No newline at end of file +``` + +## Docs + +### Markdown + +`gomarkdoc`のInstallが必要です + +```sh +go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest +gomarkdoc ./... > docs/api.md +``` + +### Webserver + +`pkgsite`のInstallが必要です + +```sh +go install golang.org/x/pkgsite/cmd/pkgsite@latest +pkgsite +``` + diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..a24a0b3 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,13 @@ + + +# slacksend + +```go +import "gitea.pglikers.com/tools/slacksen/cmd/slacksend" +``` + +## Indexv + + + +Generated by [gomarkdoc]() diff --git a/readme/dev.md b/readme/dev.md index 1fc50af..0a6ba0a 100644 --- a/readme/dev.md +++ b/readme/dev.md @@ -5,3 +5,15 @@ ```sh gofmt -w . ``` + +## Linter (Stn) + +```sh +go vet ./... +``` + +## Test + +```sh +go test ./... +``` \ No newline at end of file