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