diff --git a/README.md b/README.md index 0e4de3f..d20bb78 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # docker-trickle-megasync -Dockerfile with alpine, megasync and trickle for rate-limited sync with Mega.nz +Docker image with Alpine, Megasync and Trickle for rate-limited sync with Mega.nz + +Features: +- Headless sync with Mega.nz +- Cross platform +- integrated Trickle (https://github.com/mariusae/trickle) for bandwidth limiting (optional) + +Usage: +- Edit the docker-compose.yml file + - Change the drive mapping to your local directory + - Update your Mega credentials + - Change any desired bandwidth parameters or remove Trickle completely (default: 1MB/s down and up) +- `docker-compose build` +- `docker-compose run -d`