aboutsummaryrefslogtreecommitdiffstats
path: root/plugins
diff options
context:
space:
mode:
authorGravatar Arun Prakash Jana <engineerarun@gmail.com>2019-06-03 10:27:01 +0530
committerGravatar Arun Prakash Jana <engineerarun@gmail.com>2019-06-03 11:42:41 +0530
commit971129736279cf62cd7473af99fcbd354385821b (patch)
tree7d50a3c9df25b82e6ddc6bcee70cca0988d2cf88 /plugins
parent35fc77027ae4f4f0775994f39c2b528f252fca2b (diff)
downloadnnn-971129736279cf62cd7473af99fcbd354385821b.tar.gz
Update docs
Diffstat (limited to 'plugins')
-rw-r--r--plugins/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/plugins/README.md b/plugins/README.md
index c37a880..1d698e2 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -36,6 +36,10 @@ Plugins can access:
Each script has a _Description_ section which provides more details on what the script does, if applicable.
+#### Usage
+
+Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory.
+
#### Contributing plugins
Plugins are scripts and all scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.