]> Sergey Matveev's repositories - nnn.git/commitdiff
Update docs
authorArun Prakash Jana <engineerarun@gmail.com>
Tue, 3 Dec 2019 00:40:32 +0000 (06:10 +0530)
committerArun Prakash Jana <engineerarun@gmail.com>
Tue, 3 Dec 2019 01:26:43 +0000 (06:56 +0530)
README.md
plugins/README.md

index e8f479bf20975646262ea4d52530cd04a95e3487..99abf9bc9a9bf2e98589f3aa9ae067635ea9e1e7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ Add to that an awesome [Wiki](https://github.com/jarun/nnn/wiki)!
   - Run plugins and commands with custom keybinds
   - FreeDesktop compliant trash (needs trash-cli)
   - Cross-dir file/all/range selection
-  - Batch rename selection or dir entries
+  - Batch renamer (feature-limited) for selection or dir
   - Copy (as), move (as), delete, archive, link selection
   - Create (with parents), rename, duplicate (anywhere) files and dirs
   - Spawn a shell, run apps, run commands, execute file
index 2d2ab7c60bc98c8a4745245beb71b62bf4d4ceda..cb5b8974648b862397b9d5ed7cef4808ed5d81a2 100644 (file)
@@ -102,13 +102,9 @@ Plugins can also access the current selections by reading the `.selections` file
 
 ## Create your own plugins
 
-Plugins are a powerful yet easy way to extend the capabilities of `nnn`.
-
 Plugins are scripts that can be written in any scripting language. However, POSIX-compliant shell scripts runnable in `sh` are preferred.
 
-Each script has a _Description_ section which provides more details on what the script does, if applicable.
-
-The plugins reside in `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
+Once it's ready, drop the plugin in `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins` and make it executable. Optionally add a custom keybind in `$NNN_PLUG` if you intend to use the plugin frequently.
 
 #### Controlling `nnn`'s active directory
 `nnn` provides a mechanism for plugins to control its active directory.
@@ -156,6 +152,6 @@ There are many plugins provided by `nnn` which can be used as examples. Here are
 
 ## Contributing plugins
 
-Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.
+Add informative sections like _Description_, _Notes_, _Dependencies_, _Shell_, _Author_ etc. in the plugin as applicable. Add an entry in the table above. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.
 
-The plugins should be executable. Please add an entry in the table above.
+The plugins should be executable.