summaryrefslogtreecommitdiff
path: root/plugins/forklift
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
commit610b2529d2213a70e3d1153a9baf046c22f298b9 (patch)
tree75278ef17f12844d6810a40250b4f93abd5dd86c /plugins/forklift
parentff6d111d793970fc522dd3743367a4c3c46f5fc2 (diff)
downloadzsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.gz
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.bz2
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.zip
Clean up plugin READMEs and a few plugins
- fasd - history - mercurial - pylint - repo - yii2
Diffstat (limited to 'plugins/forklift')
-rw-r--r--plugins/forklift/README.md18
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.