documentation update

txn2 · Apr 2, 2018 · 0051232 · 0051232
1 parent d8db856
commit 0051232
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,22 @@
 
 Command line utility and [Docker] container for running [rsync] on interval.
 
+## Run Container
 
+#### Example #1
+
+Sync files from a remote server on 30 second interval
+
+```bash
+docker run --rm \
+-v "$(pwd)"/data:/data \
+-e RSYNC_PASSWORD=password \
+-e IRSYNC_INTERVAL=30 \
+-e IRSYNC_FROM="rsync://user@example.com:873/data/" \
+-e IRSYNC_TO="./data" \
+-e IRSYNC_DELETE=true \
+cjimti/irsync:1.0.0
+```
 
 ## Environment Configuration