Restrucutred and extended documentation

This commit is contained in:
Thomas Boerger
2015-12-09 10:04:44 +01:00
parent a555f47f46
commit 76dc2203f5
2 changed files with 35 additions and 72 deletions
+8 -10
View File
@@ -1,12 +1,11 @@
# drone-webhook
Drone plugin for sending Webhook notifications.
## Overview
Drone plugin for sending notifications via Webhook
This plugin is responsible for sending build notifications via Webhooks:
## Usage
```sh
./drone-webhooks <<EOF
```
./drone-webhook <<EOF
{
"repo" : {
"owner": "foo",
@@ -44,15 +43,14 @@ EOF
## Docker
Build the Docker container. Note that we need to use the `-netgo` tag so that
the binary is built without a CGO dependency:
Build the Docker container using `make`:
```sh
CGO_ENABLED=0 go build -a -tags netgo
```
make deps build
docker build --rm=true -t plugins/drone-webhook .
```
Send a Webhook notification:
### Example
```sh
docker run -i plugins/drone-webhook <<EOF