From 611aa549028ccffc2ed9a3a02f664be275b6eb9a Mon Sep 17 00:00:00 2001
From: Arne Van Maele <arnevanmaele@gmail.com>
Date: Sat, 15 Jun 2024 10:43:37 +0200
Subject: [PATCH] feat: add custom keymap section

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index d2fb9b1..eb0532d 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,13 @@ Action can be run on selected candidates provide functionality
 | Next Checkpoint| \<C-M-n\>   |Move to the next candidate and keep Ivy open and focussed                      |
 | Previous Checkpoint| \<C-M-n\>|Move to the previous candidate and keep Ivy open and focussed                 |
 
+Add your own keymaps for an action by adding a `ftplugin/ivy.lua` file in your config.
+Just add a simple keymap like this:
+
+```lua
+vim.api.nvim_set_keymap( "n", "<esc>", "<cmd>lua vim.ivy.destroy()<CR>", { noremap = true, silent = true, nowait = true })
+```
+
 
 ## API