Skip to content

Commit

Permalink
docs: Update README.md (folke#392)
Browse files Browse the repository at this point in the history
Add a link to timeout and add it to config examples.
  • Loading branch information
undg authored Jan 10, 2023
1 parent 0d289b4 commit e8261b6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ require("lazy").setup({
{
"folke/which-key",
config = function()
vim.o.timeout = true
vim.o.timeoutlen = 300
require("which-key").setup({
-- your configuration comes here
Expand All @@ -53,6 +54,7 @@ require("lazy").setup({
use {
"folke/which-key.nvim",
config = function()
vim.o.timeout = true
vim.o.timeoutlen = 300
require("which-key").setup {
-- your configuration comes here
Expand All @@ -65,7 +67,7 @@ use {

## ⚙️ Configuration

> ❗️ IMPORTANT: the timeout when **WhichKey** opens is controlled by the vim setting [timeoutlen](https://neovim.io/doc/user/options.html#'timeoutlen').
> ❗️ IMPORTANT: the [timeout](https://neovim.io/doc/user/options.html#'timeout') when **WhichKey** opens is controlled by the vim setting [timeoutlen](https://neovim.io/doc/user/options.html#'timeoutlen').
> Please refer to the documentation to properly set it up. Setting it to `0`, will effectively
> always show **WhichKey** immediately, but a setting of `500` (500ms) is probably more appropriate.
Expand Down

0 comments on commit e8261b6

Please sign in to comment.