diff --git a/README.md b/README.md index 5db8fae..a11d874 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # slack-docker -Slack integration that notifies Docker events on your host. +A Slack integration to notify Docker events. -## How to Run +## Run -Set up [an incoming WebHook](https://my.slack.com/services/new/incoming-webhook) and get the token. +Set up [an incoming WebHook integration](https://my.slack.com/services/new/incoming-webhook) and get the token. -Run a container, +Run a container ```sh docker run -d -v /var/run/docker.sock:/var/run/docker.sock -e domain=DOMAIN -e token=TOKEN -e channel=infra int128/slack-docker @@ -15,7 +15,11 @@ docker run -d -v /var/run/docker.sock:/var/run/docker.sock -e domain=DOMAIN -e t with following environment variables. -* `domain` is the first part of your .slack.com. (Mandatory) -* `token` is the token provided on the integration setup page. (Mandatory) -* `channel` is the channel without hash prefix. (Default is `general`) +* `domain` is the first part of your .slack.com. +* `token` is the token provided on the integration page. +* `channel` is the channel without hash prefix. Default is `general`. + +## Contribution + +Please let me know an issue or pull request.