From 45516ca1d830fd21f75942bf414d540db1ab0db2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc@mcornella.com>
Date: Sun, 27 Oct 2024 15:13:05 +0100
Subject: [PATCH] docs(jsontools): document requirements

Fixes #10834
---
 plugins/jsontools/README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

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: