From 2c559a496c7ca95e04b4d5cc0b71334a0f10a2c3 Mon Sep 17 00:00:00 2001
From: gramps <richmoyer@gmail.com>
Date: Tue, 2 Oct 2018 14:44:06 -0500
Subject: [PATCH] rsync: add README (#7188)

---
 plugins/rsync/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 plugins/rsync/README.md

diff --git a/plugins/rsync/README.md b/plugins/rsync/README.md
new file mode 100644
index 000000000..032ee7f3b
--- /dev/null
+++ b/plugins/rsync/README.md
@@ -0,0 +1,16 @@
+# rsync
+
+This plugin adds aliases for frequent [rsync](https://rsync.samba.org/) commands.
+
+To use it add `rsync` to the plugins array in you zshrc file.
+
+```zsh
+plugins=(... rsync)
+```
+
+| Alias               | Command                                          |
+| ------------------- | ------------------------------------------------ |
+| *rsync-copy*        | `rsync -avz --progress -h`                       |
+| *rsync-move*        | `rsync -avz --progress -h --remove-source-files` |
+| *rsync-update*      | `rsync -avzu --progress -h`                      |
+| *rsync-synchronize* | `rsync -avzu --delete --progress -h`             |