From 554b012c6c459cbb97125401103a36993ed9080c Mon Sep 17 00:00:00 2001
From: Red_M <git@red-m.net>
Date: Sun, 11 Feb 2024 09:08:09 +1000
Subject: [PATCH] Update documentation and config files

---
 README.md                  | 31 ++++++++++++++++++++++++++++---
 lua/monokai-pro/config.lua |  1 +
 2 files changed, 29 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 920c1d6..6ac2121 100644
--- a/README.md
+++ b/README.md
@@ -139,6 +139,11 @@ require("monokai-pro").setup({
   },
   ---@param c Colorscheme
   override = function(c) end,
+  ---@param cs Colorscheme
+  ---@param p ColorschemeOptions
+  ---@param Config MonokaiProOptions
+  ---@param hp Helper
+  override = function(cs: Colorscheme, p: ColorschemeOptions, Config: MonokaiProOptions, hp: Helper) end,
 })
 ```
 
@@ -251,7 +256,7 @@ require('barbecue').setup {
 let g:lightline = {'colorscheme': 'monokaipro'}
 ```
 
-- Override function:
+- Override function for customizing the final color scheme:
 
 ```lua
 require("monokai-pro").setup({
@@ -265,9 +270,9 @@ require("monokai-pro").setup({
   })
 ```
 
-- Custom your own palette:
+- Customize your own palette:
 
-This is a sample config to customize `Tokyonight` palette:
+This is a sample config to use `Tokyonight` as the palette:
 
 ```lua
 require("monokai-pro").setup({
@@ -301,6 +306,26 @@ require("monokai-pro").setup({
   })
 ```
 
+- Customize the scheme:
+
+This is a sample config to use a darker background for almost all supported plugins:
+
+```lua
+require("monokai-pro").setup({
+    -- ...
+    overrideScheme = function(cs, p, config, hp)
+      local cs_override = {}
+      local calc_bg = hp.blend(p.background, 0.75, '#000000')
+
+      cs_override.editor = {
+        background = calc_bg,
+      }
+      return cs_override
+    end
+    -- ...
+  })
+```
+
 ## 🔧 Command
 
 - run command `MonokaiProSelect` to launch a menu to choose theme filter (required: [nui.nvim](https://github.com/MunifTanjim/nui.nvim))
diff --git a/lua/monokai-pro/config.lua b/lua/monokai-pro/config.lua
index 5ef767a..abb7ac6 100644
--- a/lua/monokai-pro/config.lua
+++ b/lua/monokai-pro/config.lua
@@ -3,6 +3,7 @@ local util = require("monokai-pro.util")
 ---@field plugins? PluginConfig
 ---@field override? fun(c: Colorscheme)
 ---@field overridePalette? fun(filter: Filter) A function to override palette
+---@field overrideScheme? fun(cs: Colorscheme, p: ColorschemeOptions, Config: MonokaiProOptions, hp: Helper) A function to override scheme
 local config = {
   transparent_background = false,
   terminal_colors = true,