From d3d5a35532bdd3e7f4d28cb4e5e4a30d5401cef8 Mon Sep 17 00:00:00 2001
From: Jonas Dujava <jonas.dujava@gmail.com>
Date: Sun, 14 Jul 2024 08:34:05 +0200
Subject: [PATCH] docs: recipe to modify a style

Signed-off-by: Jonas Dujava <jonas.dujava@gmail.com>
---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index c54255cc6..cd9c6f019 100644
--- a/README.md
+++ b/README.md
@@ -383,6 +383,30 @@ require("tokyonight").setup({
 
 </details>
 
+<details>
+  <summary>Create a Modified Style</summary>
+
+To modify a style before all of the `colors` and `highlights` are generated
+from the corresponding color palette, you can use the following:
+
+```lua
+local styles = require('tokyonight.colors').styles
+
+-- change the colors for your new palette here
+---@type Palette
+local modified_colors = {
+    bg = '#1e1e1e',
+    fg = '...',
+    ...,
+}
+-- save as `custom` style (by extending the `storm` style)
+styles.custom = vim.tbl_extend('force', styles.storm --[[@as Palette]], modified_colors)
+
+require('tokyonight').load(opts) -- load custom style (be sure to have opts.style = 'custom')
+```
+
+</details>
+
 <details>
   <summary>Fix <code>undercurls</code> in Tmux</summary>