From ec0d17bd02e581534945ea3b9a6b7401587b6ec3 Mon Sep 17 00:00:00 2001
From: clunietp <1031470+clunietp@users.noreply.github.com>
Date: Fri, 27 Dec 2019 06:43:53 -0500
Subject: [PATCH] Update README.md

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

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`