Browse Source

Update README formatting

Marc Cornellà 7 years ago
parent
commit
3d8ee47c7a
1 changed files with 21 additions and 5 deletions
  1. 21 5
      plugins/transfer/README.md

+ 21 - 5
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/
+```