summaryrefslogtreecommitdiff
path: root/plugins/transfer/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/transfer/README.md')
-rw-r--r--plugins/transfer/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/transfer/README.md b/plugins/transfer/README.md
new file mode 100644
index 000000000..5fa064445
--- /dev/null
+++ b/plugins/transfer/README.md
@@ -0,0 +1,24 @@
+# `transfer` plugin
+
+[`transfer.sh`](https://transfer.sh) is an easy to use file sharing service from the command line
+
+## Usage
+
+Add `transfer` to your plugins array in your zshrc file:
+```zsh
+plugins=(... transfer)
+```
+
+Then you can:
+
+- transfer a file:
+
+```zsh
+transfer file.txt
+```
+
+- transfer a whole directory (it will be automatically compressed):
+
+```zsh
+transfer directory/
+```