From 124980936ae1cdccedcdaf7bf66c82413d7e4c11 Mon Sep 17 00:00:00 2001
From: Mike Smith <10135646+mikesmithgh@users.noreply.github.com>
Date: Wed, 18 Dec 2024 08:00:11 -0500
Subject: [PATCH] chore: add note about only supporting zsh 5.9+

---
 README.md                    | 5 +++++
 lua/kitty-scrollback/api.lua | 3 +++
 2 files changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 2b32f5e..5db504e 100644
--- a/README.md
+++ b/README.md
@@ -882,6 +882,8 @@ The API is available via the `kitty-scrollback.api` module. e.g., `require('kitt
 
 > [!NOTE]  
 > Command-line editing is only supported for `bash`, `fish`, or `zsh`
+> Only `zsh` version 5.9 or greater is supported by kitty-scrollback.nvim for command-line editing. If you are using `zsh`,
+> please confirm you have a compatible version by running `zsh --version`
 
 Generate the configuration and add it to the appropriate location. The comments in the configuration will provide
 additional setup instructions. `KittyScrollbackGenerateCommandLineEditing` requires one parameter, either `bash`, `fish`, or `zsh`.
@@ -995,6 +997,9 @@ command-line buffer in the editor defined in the `VISUAL` environment variable.
 - Run `nvim --headless +'KittyScrollbackGenerateCommandLineEditing zsh'`. You should see similar output to the following:
 
 ```zsh
+# IMPORTANT: kitty-scrollback.nvim only supports zsh 5.9 or greater for command-line editing,
+# please check your version by running: zsh --version
+
 # add the following environment variables to your zsh config (e.g., ~/.zshrc)
 
 autoload -Uz edit-command-line
diff --git a/lua/kitty-scrollback/api.lua b/lua/kitty-scrollback/api.lua
index e79a6a0..7a7f496 100644
--- a/lua/kitty-scrollback/api.lua
+++ b/lua/kitty-scrollback/api.lua
@@ -223,6 +223,9 @@ M.generate_command_line_editing = function(shell)
       [[]],
     },
     zsh = {
+      [[# IMPORTANT: kitty-scrollback.nvim only supports zsh 5.9 or greater for command-line editing,]],
+      [[# please check your version by running: zsh --version]],
+      [[]],
       [[# add the following environment variables to your zsh config (e.g., ~/.zshrc)]],
       [[]],
       [[autoload -Uz edit-command-line]],