Browse Source

docs(jsontools): document requirements

Fixes #10834
Marc Cornellà 4 weeks ago
parent
commit
45516ca1d8
1 changed files with 11 additions and 0 deletions
  1. 11 0
      plugins/jsontools/README.md

+ 11 - 0
plugins/jsontools/README.md

@@ -8,6 +8,17 @@ To use it, add `jsontools` to the plugins array in your zshrc file:
 plugins=(... jsontools)
 plugins=(... jsontools)
 ```
 ```
 
 
+## Requirements
+
+The plugin uses one of these tools to process JSON data, in the following order:
+
+- `node`
+- `python3`
+- `ruby`
+
+Any of these must be in `$PATH` before the plugin is loaded, otherwise the plugin exits
+prematurely and the functions will not be available.
+
 ## Usage
 ## Usage
 
 
 Usage is simple... just take your json data and pipe it into the appropriate jsontool:
 Usage is simple... just take your json data and pipe it into the appropriate jsontool: