update docs + do not allow primary refresh timer to be set to 0

Author: shadmansaleh

README.md

@@ -145,9 +145,9 @@ require('lualine').setup {
     always_show_tabline = true,
     globalstatus = false,
     refresh = {
-      statusline = 100,
-      tabline = 100,
-      winbar = 100,
+      statusline = 1000,
+      tabline = 1000,
+      winbar = 1000,
       refresh_time = 16, -- ~60fps
       events = {
         'WinEnter',

lua/lualine/config.lua

@@ -61,6 +61,16 @@ local config = {
   extensions = {},
 }
 
+--- Ensure sure user config doesn't disable lualine refresh completely
+---@param options table
+---@return table
+local function fix_refresh_timer(options)
+  if options.refresh.refresh_time <= 0 then
+    options.refresh.refresh_time = 16
+  end
+  return options
+end
+
 --- change separator format 'x' to {left='x', right='x'}
 ---@param separators string|table
 ---@return table
@@ -131,6 +141,7 @@ local function apply_configuration(config_table)
   if config_table.extensions then
     config.extensions = utils.deepcopy(config_table.extensions)
   end
+  config.options = fix_refresh_timer(config.options)
   config.options.section_separators = fix_separators(config.options.section_separators)
   config.options.component_separators = fix_separators(config.options.component_separators)
   config.options.disabled_filetypes = fix_disabled_filetypes(config.options.disabled_filetypes)