summaryrefslogtreecommitdiff
path: root/plugins/transfer
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2018-05-25 20:44:56 +0200
committerGitHub <noreply@github.com>2018-05-25 20:44:56 +0200
commit3d8ee47c7a55119318d698a90f523e04fffb878d (patch)
tree45f6fde1a33a648c0a8b546d8d1cc095fcfe7a28 /plugins/transfer
parentc36474b7dfbe19c0628f6f21d8da40b535eeb5fb (diff)
downloadzsh-3d8ee47c7a55119318d698a90f523e04fffb878d.tar.gz
zsh-3d8ee47c7a55119318d698a90f523e04fffb878d.tar.bz2
zsh-3d8ee47c7a55119318d698a90f523e04fffb878d.zip
Update README formatting
Diffstat (limited to 'plugins/transfer')
-rw-r--r--plugins/transfer/README.md26
1 files changed, 21 insertions, 5 deletions
diff --git a/plugins/transfer/README.md b/plugins/transfer/README.md
index 9bf488d4e..5fa064445 100644
--- a/plugins/transfer/README.md
+++ b/plugins/transfer/README.md
@@ -1,8 +1,24 @@
-# `transfer.sh` plugin
-transfer.sh is an easy file sharing service from the command line
+# `transfer` plugin
+
+[`transfer.sh`](https://transfer.sh) is an easy to use file sharing service from the command line
## Usage
-Example
-> transfer file.txt
-> transfer directory/
+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/
+```