summaryrefslogtreecommitdiff
path: root/plugins/forklift
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/forklift')
-rw-r--r--plugins/forklift/README.md15
-rw-r--r--plugins/forklift/forklift.plugin.zsh2
2 files changed, 16 insertions, 1 deletions
diff --git a/plugins/forklift/README.md b/plugins/forklift/README.md
new file mode 100644
index 000000000..6c5cbab23
--- /dev/null
+++ b/plugins/forklift/README.md
@@ -0,0 +1,15 @@
+## forklift
+
+Plugin for ForkLift, an FTP application for OS X.
+
+### Requirements
+
+* [ForkLift](http://www.binarynights.com/forklift/)
+
+### Usage
+
+<code>fl [*file_or_folder*]</code>
+
+* 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 called with a non-directory file as the argument, then the file's parent directory is opened.
diff --git a/plugins/forklift/forklift.plugin.zsh b/plugins/forklift/forklift.plugin.zsh
index b0e60a434..692ca5790 100644
--- a/plugins/forklift/forklift.plugin.zsh
+++ b/plugins/forklift/forklift.plugin.zsh
@@ -1,4 +1,4 @@
-# Open folder in ForkLift.app of ForkLift2.app from console
+# Open folder in ForkLift.app or ForkLift2.app from console
# Author: Adam Strzelecki nanoant.com, modified by Bodo Tasche bitboxer.de
# Updated to support ForkLift2 by Johan Kaving
#