From ef82e79731392d85771899ee759157dc27363e10 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc.cornella@live.com>
Date: Tue, 20 Sep 2016 21:45:47 +0200
Subject: [PATCH] cp plugin: add a README file

---
 plugins/cp/README.md     | 32 ++++++++++++++++++++++++++++++++
 plugins/cp/cp.plugin.zsh | 13 -------------
 2 files changed, 32 insertions(+), 13 deletions(-)
 create mode 100644 plugins/cp/README.md

diff --git a/plugins/cp/README.md b/plugins/cp/README.md
new file mode 100644
index 000000000..528925cce
--- /dev/null
+++ b/plugins/cp/README.md
@@ -0,0 +1,32 @@
+# cp plugin
+
+This plugin defines a `cpv` function that uses `rsync` so that you
+get the features and security of this command.
+
+To enable, add `cp` to your `plugins` array in your zshrc file:
+
+```zsh
+plugins=(... cp)
+```
+
+## Description
+
+The enabled options for rsync are:
+
+- `-p`: preserves permissions.
+
+- `-o`: preserves owner.
+
+* `-g`: preserves group.
+
+* `-b`: make a backup of the original file instead of overwriting it, if it exists.
+
+* `-hhh`: outputs numbers in human-readable format, in units of 1024 (K, M, G, T).
+
+* `--backup-dir=/tmp/rsync`: move backup copies to "/tmp/rsync".
+
+* `-e /dev/null`: only work on local files (disable remote shells).
+
+* `--progress`: display progress.
+
+* `--`: everything after this is an argument, even if it starts with a hyphen.
diff --git a/plugins/cp/cp.plugin.zsh b/plugins/cp/cp.plugin.zsh
index 226efc29e..a80f56eca 100644
--- a/plugins/cp/cp.plugin.zsh
+++ b/plugins/cp/cp.plugin.zsh
@@ -1,16 +1,3 @@
-#Show progress while file is copying
-
-# Rsync options are:
-#  -p - preserve permissions
-#  -o - preserve owner
-#  -g - preserve group
-#  -h - output in human-readable format
-#  --progress - display progress
-#  -b - instead of just overwriting an existing file, save the original
-#  --backup-dir=/tmp/rsync - move backup copies to "/tmp/rsync"
-#  -e /dev/null - only work on local files
-#  -- - everything after this is an argument, even if it looks like an option
-
 cpv() {
     rsync -pogb -hhh --backup-dir=/tmp/rsync -e /dev/null --progress -- "$@"
 }