From 0b75267c4f9115bbec64ea5c67d8c7e0d98b557b Mon Sep 17 00:00:00 2001 From: Thomas Boerger Date: Fri, 15 Feb 2019 11:58:30 +0100 Subject: [PATCH] Unified documentation and readme --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7fd0641..3d70cc6 100644 --- a/README.md +++ b/README.md @@ -12,26 +12,31 @@ Drone plugin to synchronize a directory with an Amazon S3 Bucket. For the usage ## Build -Build the binary with the following commands: +Build the binary with the following command: -``` -go build +```console +export GOOS=linux +export GOARCH=amd64 +export CGO_ENABLED=0 +export GO111MODULE=on + +go build -v -a -tags netgo -o release/linux/amd64/drone-s3-sync ``` ## Docker -Build the Docker image with the following commands: +Build the Docker image with the following command: -``` -GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-s3-sync -docker build --rm -t plugins/s3-sync . +```console +docker build \ + --label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \ + --label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \ + --file docker/Dockerfile.linux.amd64 --tag plugins/s3-sync . ``` ## Usage -Execute from the working directory: - -```sh +```console docker run --rm \ -e PLUGIN_SOURCE= \ -e PLUGIN_TARGET= \