diff options
| author | Marc Cornellà <marc@mcornella.com> | 2024-10-27 15:13:05 +0100 |
|---|---|---|
| committer | Marc Cornellà <marc@mcornella.com> | 2024-10-27 15:13:58 +0100 |
| commit | 45516ca1d830fd21f75942bf414d540db1ab0db2 (patch) | |
| tree | 99f9504148379cfe66bea0584de486a26342c78b | |
| parent | eeb01c18c1d1edff0c2563764a998b2d30947844 (diff) | |
| download | zsh-45516ca1d830fd21f75942bf414d540db1ab0db2.tar.gz zsh-45516ca1d830fd21f75942bf414d540db1ab0db2.tar.bz2 zsh-45516ca1d830fd21f75942bf414d540db1ab0db2.zip | |
docs(jsontools): document requirements
Fixes #10834
| -rw-r--r-- | plugins/jsontools/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/plugins/jsontools/README.md b/plugins/jsontools/README.md index d92608806..804edba40 100644 --- a/plugins/jsontools/README.md +++ b/plugins/jsontools/README.md @@ -8,6 +8,17 @@ To use it, add `jsontools` to the plugins array in your zshrc file: 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 is simple... just take your json data and pipe it into the appropriate jsontool: |