diff --git a/README.md b/README.md index 31907f2..a1fc42f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # drone-s3-sync [![Build Status](http://beta.drone.io/api/badges/drone-plugins/drone-s3-sync/status.svg)](http://beta.drone.io/drone-plugins/drone-s3-sync) -[![](https://badge.imagelayers.io/plugins/drone-s3-sync:latest.svg)](https://imagelayers.io/?images=plugins/drone-s3-sync:latest 'Get your own badge on imagelayers.io') +[![Go Doc](https://godoc.org/github.com/drone-plugins/drone-s3-sync?status.svg)](http://godoc.org/github.com/drone-plugins/drone-s3-sync) +[![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-s3-sync)](https://goreportcard.com/report/github.com/drone-plugins/drone-s3-sync) +[![Join the chat at https://gitter.im/drone/drone](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/drone/drone) -Drone plugin to synchronize a directory with an Amazon S3 Bucket. For the usage information and a listing of the available options please take a look at [the docs](DOCS.md). +Drone plugin to synchronize a directory with an Amazon S3 Bucket. For the +usage information and a listing of the available options please take a look at +[the docs](DOCS.md). ## Build Build the binary with the following commands: ``` -export GO15VENDOREXPERIMENT=1 -export GOOS=linux -export GOARCH=amd64 -export CGO_ENABLED=0 - -go build -a -tags netgo +go build +go test ``` ## Docker @@ -23,10 +23,12 @@ go build -a -tags netgo Build the docker image with the following commands: ``` +CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags netgo docker build --rm=true -t plugins/s3-sync . ``` -Please note incorrectly building the image, with the wrong OS, architecture, or with CGO enabled will result in an error when running the Docker image: +Please note incorrectly building the image for the correct x64 linux and with +GCO disabled will result in an error when running the Docker image: ``` docker: Error response from daemon: Container command @@ -35,16 +37,16 @@ docker: Error response from daemon: Container command ## Usage -Build and publish from your current working directory: +Execute from the working directory: -``` +```sh docker run --rm \ - -e PLUGIN_SOURCE= \ - -e PLUGIN_TARGET= \ - -e PLUGIN_BUCKET= \ - -e AWS_ACCESS_KEY_ID= \ + -e PLUGIN_SOURCE= \ + -e PLUGIN_TARGET= \ + -e PLUGIN_BUCKET= \ + -e AWS_ACCESS_KEY_ID= \ -e AWS_SECRET_ACCESS_KEY= \ - -v $(pwd):$(pwd) \ - -w $(pwd) \ + -v $(pwd):$(pwd) \ + -w $(pwd) \ plugins/s3-sync ```