From 3afe09955cdd5d94056e93ad9ead9d0bdbd66749 Mon Sep 17 00:00:00 2001 From: David Stefan Date: Sun, 30 Apr 2017 13:41:50 +0100 Subject: [PATCH] docs: basic usage info --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7601166..264f126 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # rsync -A small Docker image with a simplistic rsync server. It is intended to be used as a volume image and shared across containers where standard volume sharing results in poor performance. + +A simple rsync server that runs inside Docker. It is intended to be used as a volume and shared among containers where +standard volume sharing results in poor read performance. + +# Usage + +The simplest use case is to run the image and map its 873 port: + +```$ docker run stefda/rsync -p 873:873``` + +The command above will spin up a container that listens on port 873 for rsync connections.