Merge pull request #5 from drone-plugins/feature/readme

Added readme, drone and imagelayers badges
This commit is contained in:
Thomas Boerger 2016-01-18 01:10:15 +01:00
commit 302613545d

65
README.md Normal file
View File

@ -0,0 +1,65 @@
# 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')
Drone plugin to synchronize files and folders with Amazon S3
## Usage
```sh
./drone-s3-sync <<EOF
{
"repo": {
"clone_url": "git://github.com/drone/drone",
"full_name": "drone/drone"
},
"build": {
"event": "push",
"branch": "master",
"commit": "436b7a6e2abaddfd35740527353e78a227ddcb2c",
"ref": "refs/heads/master"
},
"workspace": {
"root": "/drone/src",
"path": "/drone/src/github.com/drone/drone"
},
"vargs": {
}
}
EOF
```
## Docker
Build the Docker container using `make`:
```sh
make deps build
docker build --rm=true -t plugins/drone-s3-sync .
```
### Example
```sh
docker run -i plugins/drone-s3-sync <<EOF
{
"repo": {
"clone_url": "git://github.com/drone/drone",
"full_name": "drone/drone"
},
"build": {
"event": "push",
"branch": "master",
"commit": "436b7a6e2abaddfd35740527353e78a227ddcb2c",
"ref": "refs/heads/master"
},
"workspace": {
"root": "/drone/src",
"path": "/drone/src/github.com/drone/drone"
},
"vargs": {
}
}
EOF
```