diff --git a/README.md b/README.md index 94d1019..b835a15 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,25 @@ You will want to add your style of remaps and such to your neovim dotfiles with the shortcuts you like. My shortcuts are for me. Me alone. Which also means they are designed with dvorak in mind (My layout btw, I use dvorak btw). +### harpoon:setup +it is a requirement to call `harpoon:setup()`. This is required due to +autocmds setup. + +### Basic Setup +Here is my basic setup + ```lua local harpoon = require("harpoon") -harpoon.ui:toggle_quick_menu(harpoon:list()) +harpoon:setup() + +vim.keymap.set("n", "a", function() harpoon:list():append() end) +vim.keymap.set("n", "", function() harpoon.ui:toggle_quick_menu(harpoon:list()) end) + +vim.keymap.set("n", "", function() harpoon:list():select(1) end) +vim.keymap.set("n", "", function() harpoon.ui:select(2) end) +vim.keymap.set("n", "", function() harpoon.ui:select(3) end) +vim.keymap.set("n", "", function() harpoon.ui:select(4) end) ``` ## ⇁ Social