summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/forklift/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/forklift/README.md')
-rw-r--r--oh-my-zsh/plugins/forklift/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/forklift/README.md b/oh-my-zsh/plugins/forklift/README.md
new file mode 100644
index 0000000..7dfd8bf
--- /dev/null
+++ b/oh-my-zsh/plugins/forklift/README.md
@@ -0,0 +1,23 @@
+# forklift
+
+Plugin for ForkLift, an FTP application for OS X.
+
+To use it, add `forklift` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... forklift)
+```
+
+## Requirements
+
+* [ForkLift](https://binarynights.com/)
+
+## Usage
+
+`fl [<file_or_folder>]`
+
+* If `fl` is called without arguments then the current folder is opened in ForkLift. This is equivalent to `fl .`.
+
+* If `fl` is called with a directory as the argument, then that directory is opened in ForkLift
+
+* If `fl` is called with a non-directory file as the argument, then the file's parent directory is opened.