feat: readme

This commit is contained in:
Michael Paulson 2023-12-01 14:25:03 -07:00
parent 5bb4d59d4d
commit 7e37a12b06

View File

@ -14,6 +14,9 @@
* [The Solutions](#-The-Solutions) * [The Solutions](#-The-Solutions)
* [Installation](#-Installation) * [Installation](#-Installation)
* [Getting Started](#-Getting-Started) * [Getting Started](#-Getting-Started)
* [API](#-API)
* [Config](#config)
* [Settings](#settings)
* [Social](#-Social) * [Social](#-Social)
* [Note to legacy Harpoon 1 users](#-Note-to-legacy-Harpoon-1-users) * [Note to legacy Harpoon 1 users](#-Note-to-legacy-Harpoon-1-users)
@ -71,7 +74,7 @@ vim.keymap.set("n", "<C-n>", function() harpoon:list():select(3) end)
vim.keymap.set("n", "<C-s>", function() harpoon:list():select(4) end) vim.keymap.set("n", "<C-s>", function() harpoon:list():select(4) end)
``` ```
### Custom Lists ## ⇁ API
You can define custom behavior of a harpoon list by providing your own calls. You can define custom behavior of a harpoon list by providing your own calls.
Here is a simple example where i create a list named `cmd` that takes the Here is a simple example where i create a list named `cmd` that takes the