diff --git a/README.md b/README.md index 6215dc3..54a1708 100644 --- a/README.md +++ b/README.md @@ -125,8 +125,16 @@ require("lazy").setup({ frequency = 3600, -- check for updates every hour }, performance = { - ---@type LazyCacheConfig - cache = nil, + cache = { + enabled = true, + path = vim.fn.stdpath("state") .. "/lazy.state", + -- Once one of the following events triggers, caching will be disabled. + -- To cache all modules, set this to `{}`, but that is not recommended. + -- The default is to disable on: + -- * VimEnter: not useful to cache anything else beyond startup + -- * BufReadPre: this will be triggered early when opening a file from the command line directly + disable_events = { "VimEnter", "BufReadPre" }, + }, reset_packpath = true, -- reset the package path to improve startup time rtp = { reset = true, -- reset the runtime path to $VIMRUNTIME and your config directory