[FEATURE REQUEST] Update Readme keymap config examples with description

[dzintars]

Issues

• I have checked existing issues and there are no existing ones with the same request.

Feature description

I would suggest to update key binding examples to:

vim.api.nvim_set_keymap(
    "n",
    "<leader>ns",
    "<cmd>lua require('package-info').show()<cr>",
    { silent = true, noremap = true, desc = "package-info | Show" }
)

Note the , desc = "package-info | Show" addition.

While this is "opinionated" thing to do, I do believe that newer Nvim users will benefit of cleaner :map n or :Telescope keymaps or which-key key descriptions. This enables easier duplicate keybinding finding and seeing "what is what and from where does it comes".

Also, examples could be improved with vim.keymap.set()

Help

Yes

Implementation help

No response

[vuki656]

Makes sense. Feel free to open a PR.