aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Arun Prakash Jana <engineerarun@gmail.com>2019-11-17 23:28:32 +0530
committerGravatar Arun Prakash Jana <engineerarun@gmail.com>2019-11-18 00:14:04 +0530
commitf7fa1ffc8ec818f38a8d480e2b2fa9e4a8babfcb (patch)
tree82d66f08c7faafd4fa637a1f5ed84d7aa9ba2d4b
parent6bbf3ac9c4cd143fb0c867ce5c320a5a0f206b44 (diff)
downloadnnn-f7fa1ffc8ec818f38a8d480e2b2fa9e4a8babfcb.tar.gz
Update plugin docs
-rw-r--r--README.md2
-rw-r--r--plugins/README.md10
2 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index e968f4c..521557b 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@
`nnn` is a full-featured terminal file manager. It's tiny, [extremely light and fast](https://github.com/jarun/nnn/wiki/Performance).
-`nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has tons of plugins to extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim).
+`nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has tons of plugins and plugin-specific documentation to extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim).
It runs smoothly on the Raspberry Pi, Termux [on Android](https://www.youtube.com/watch?v=AbaauM7gUJw), Linux, macOS, BSD, Cygwin and Linux subsystem for Windows. `nnn` works seamlessly with DEs and GUI utilities. It's nearly zero-config (with sensible defaults) and can be setup in less than 5 minutes.
diff --git a/plugins/README.md b/plugins/README.md
index 304888b..1e5a701 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -1,11 +1,16 @@
<h1 align="center">nnn plugins</h1>
+<p align="center"><img src="https://i.imgur.com/SpT0L2W.png" /></p>
+<p align="center"><i>read ebooks with plugin gutenread (Android)</i></p>
+
<p align="center"><img src="https://i.imgur.com/14iPDIq.png" /></p>
<p align="center"><i>image preview with plugin thumb</i></p>
+## Introduction
+
Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or binaries) which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins.
-The currently available plugins are listed below.
+## List of plugins
| Plugin (a-z) | Lang | Deps | Description |
| --- | --- | --- | --- |
@@ -51,9 +56,6 @@ The currently available plugins are listed below.
| vidthumb | sh | [ffmpegthumbnailer](https://github.com/dirkvdb/ffmpegthumbnailer),<br>[lsix](https://github.com/hackerb9/lsix) | Show video thumbnails in terminal |
| viuimg | sh | [viu](https://github.com/atanunq/viu), less | View an image or images in dir in `$PAGER` |
-<p align="center"><img src="https://i.imgur.com/SpT0L2W.png" /></p>
-<p align="center"><i>read ebooks with plugin gutenread (Android)</i></p>
-
## Installing plugins
The following command installs all plugins: