45516ca1d830fd21f75942bf414d540db1ab0db2

Author
Marc Cornellà <marc@mcornella.com>
Committer
Marc Cornellà <marc@mcornella.com>
Date

Message

docs(jsontools): document requirements

Fixes #10834

Diff

 1diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md
 2index d926088064aacebca7eb49a663ae0f08e3c52dbb..804edba40850bbe7ee7efa3d3062e43b4b09aff4 100644
 3--- a/plugins/jsontools/README.md
 4+++ b/plugins/jsontools/README.md
 5@@ -8,6 +8,17 @@ To use it, add `jsontools` to the plugins array in your zshrc file:
 6 plugins=(... jsontools)
 7 ```
 8 
 9+## Requirements
10+
11+The plugin uses one of these tools to process JSON data, in the following order:
12+
13+- `node`
14+- `python3`
15+- `ruby`
16+
17+Any of these must be in `$PATH` before the plugin is loaded, otherwise the plugin exits
18+prematurely and the functions will not be available.
19+
20 ## Usage
21 
22 Usage is simple... just take your json data and pipe it into the appropriate jsontool: