diff options
Diffstat (limited to 'plugins/forklift/README.md')
| -rw-r--r-- | plugins/forklift/README.md | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/plugins/forklift/README.md b/plugins/forklift/README.md index 6c4ce1e81..7dfd8bf95 100644 --- a/plugins/forklift/README.md +++ b/plugins/forklift/README.md @@ -1,15 +1,23 @@ -## forklift +# forklift Plugin for ForkLift, an FTP application for OS X. -### Requirements +To use it, add `forklift` to the plugins array in your zshrc file: + +```zsh +plugins=(... forklift) +``` + +## Requirements * [ForkLift](https://binarynights.com/) -### Usage +## Usage -<code>fl [*file_or_folder*]</code> +`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 called with a non-directory file as the argument, then the file's parent directory is opened. +* 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. |