From 6efd3e066de1666f47b9928cda5097ef558d4c78 Mon Sep 17 00:00:00 2001 From: Shadorain Date: Mon, 11 Oct 2021 17:52:19 +0000 Subject: [PATCH] Added a keybinds section to display specs whenever This section shows the user the availability of the `show_specs()` function which gives them the ability to add it to keybinds to find the cursor easily. Shows them example use cases as well outside of just invoking it regularly. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 88bcb82..8576fcb 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,21 @@ require('specs').setup{ } } ``` + +### Keybinds + +You can invoke specs from anywhere by using `:lua require('specs').show_specs()` +Add a keybind for this to make it easy to find your cursor at any time. + +```lua +-- Press to call specs! +vim.api.nvim_set_keymap('n', '', ':lua require("specs").show_specs()', { noremap = true, silent = true }) + +-- You can even bind it to search jumping and more, example: +vim.api.nvim_set_keymap('n', 'n', 'n:lua require("specs").show_specs()', { noremap = true, silent = true }) +vim.api.nvim_set_keymap('n', 'N', 'N:lua require("specs").show_specs()', { noremap = true, silent = true }) +``` + ## Planned Features - [ ] More builtin faders + resizers - [ ] Colorizers