dotfiles

1 files changed, 41 insertions, 0 deletions

diff --git a/zsh/oh-my-zsh/plugins/transfer/README.md b/zsh/oh-my-zsh/plugins/transfer/README.md
new file mode 100644
index 0000000..825c9a2
--- /dev/null
+++ b/zsh/oh-my-zsh/plugins/transfer/README.md
@@ -0,0 +1,41 @@
+# `transfer` plugin
+
+[`transfer.sh`](https://transfer.sh) is an easy to use file sharing service from the command line
+
+To use it, add `transfer` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... transfer)
+```
+
+## Usage
+
+- Transfer a file: `transfer file.txt`.
+
+- Transfer a whole directory (it will be automatically compressed): `transfer dir`.
+
+### Encryption / Decryption
+
+- Encrypt and upload a file with symmetric cipher and create ASCII armored output:
+
+  ```zsh
+  transfer file -ca
+  ```
+
+- Encrypt and upload directory with symmetric cipher and gpg output:
+
+  ```zsh
+  transfer directory -ca
+  ```
+
+- Decrypt file:
+
+  ```zsh
+  gpg -d file -ca
+  ```
+
+- Decrypt directory:
+
+  ```zsh
+  gpg -d your_archive.tgz.gpg | tar xz
+  ```