Skip to content

Commit

Permalink
docs: clarify installation instructions for new users
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgrieser committed Dec 3, 2024
1 parent 2bbe4d3 commit f1851ce
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ section for information on setting your own keymaps.
-- lazy.nvim
{
"chrisgrieser/nvim-various-textobjs",
lazy = true,
keys = {
-- ...
},
Expand All @@ -120,12 +119,14 @@ The `.setup()` call is optional if you are fine with the defaults below.
```lua
-- default config
require("various-textobjs").setup {
-- use suggested keymaps (see overview table in README)
-- See overview table in README for the defaults keymaps.
-- (Note that lazy-loading this plugin, the default keymaps cannot be set up.
-- if you set this to `true`, you thus need to add `event = "VeryLazy"` to your
-- lazy.nvim config.)
useDefaultKeymaps = false,

-- disable only some default keymaps, e.g. { "ai", "ii" }
---@type string[]
disabledKeymaps = {},
disabledKeymaps = {}, -- disable only some default keymaps, e.g. { "ai", "ii" }

-- Number of lines to seek forwards for a text object. See the overview table
-- in the README for which text object uses which value.
Expand Down
8 changes: 5 additions & 3 deletions lua/various-textobjs/config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@ local M = {}
--------------------------------------------------------------------------------
---@class VariousTextobjs.Config
local defaultConfig = {
-- use suggested keymaps (see overview table in README)
-- See overview table in README for the defaults keymaps.
-- (Note that lazy-loading this plugin, the default keymaps cannot be set up.
-- if you set this to `true`, you thus need to add `lazy = false` to your
-- lazy.nvim config.)
useDefaultKeymaps = false,

-- disable only some default keymaps, e.g. { "ai", "ii" }
---@type string[]
disabledKeymaps = {},
disabledKeymaps = {}, -- disable only some default keymaps, e.g. { "ai", "ii" }

-- Number of lines to seek forwards for a text object. See the overview table
-- in the README for which text object uses which value.
Expand Down

0 comments on commit f1851ce

Please sign in to comment.