Rename vivid contrast to dim(its very dim); Update README.md

README.md

@@ -9,6 +9,17 @@ A pure-black refresh of the retro-groove aesthetic for modern displays. Darkbox
 - Retro-groove inspired color palette with modern refinements
 - Built-in support for tree-sitter
 
+## 📸 Screenshots
+
+### Base
+![Screenshot](.github/screenshot.png)
+
+### Classic
+![Screenshot](.github/screenshot_classic.png)
+
+### Dim
+![Screenshot](.github/screenshot_dim.png)
+
 ## 🚀 Installation
 
 ### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
@@ -25,9 +36,54 @@ return {
 }
 ```
 
-## 📸 Screenshot
+## ✏️ Configuration
 
-![Screenshot](.github/screenshot.png)
+Additional settings for darkbox are available:
+```lua
+-- Default options:
+require("darkbox").setup({
+  terminal_colors = true, -- add neovim terminal colors
+  undercurl = true,
+  underline = true,
+  bold = true,
+  italic = {
+    strings = true,
+    emphasis = true,
+    comments = true,
+    operators = false,
+    folds = true,
+  },
+  strikethrough = true,
+  invert_selection = false,
+  invert_signs = false,
+  invert_tabline = false,
+  invert_intend_guides = false,
+  inverse = true, -- invert background for search, diffs, statuslines and errors
+  contrast = "", -- can be "classic", "dim" or empty string
+  palette_overrides = {},
+  overrides = {},
+  dim_inactive = false,
+  transparent_mode = false,
+})
+vim.cmd("colorscheme darkbox")
+```
+
+**VERY IMPORTANT**: Make sure to call setup() **BEFORE** calling the colorscheme command, to use your custom configs
+
+## 🔧 Overrides 
+
+### Palette 
+
+You can specify your own palette colors. For example:
+
+```lua
+require("darkbox").setup({
+    palette_overrides = {
+       base_red = "#991900",
+    }
+})
+vim.cmd("colorscheme darkbox")
+```
 
 ## 🤝 Contributing
 

lua/darkbox.lua

@@ -11,7 +11,7 @@
 ---@field palette DarkboxPalette
 local Darkbox = {}
 
----@alias Contrast "classic" | "vivid" | ""
+---@alias Contrast "classic" | "dim" | ""
 
 ---@class ItalicConfig
 ---@field strings boolean
@@ -84,9 +84,9 @@ Darkbox.palette = {
   background_3 = "#665c54",
   background_4 = "#7c6f64",
   classic_foreground = "#ebdbb2",
-  base_foreground = "#d5c4a1",
+  base_foreground = "#bdae93",
-  vivid_foreground = "#a89984",
+  dim_foreground = "#a89984",
-  foreground_1 = "#ebdbb2",
+  foreground_1 = "#bdae93",
   foreground_2 = "#d5c4a1",
   foreground_3 = "#bdae93",
   foreground_4 = "#a89984",
@@ -104,13 +104,13 @@ Darkbox.palette = {
   base_purple = "#b16286",
   base_aqua = "#689d6a",
   base_orange = "#d65d0e",
-  vivid_red = "#9d0006",
+  dim_red = "#9d0006",
-  vivid_green = "#79740e",
+  dim_green = "#79740e",
-  vivid_yellow = "#b57614",
+  dim_yellow = "#b57614",
-  vivid_blue = "#076678",
+  dim_blue = "#076678",
-  vivid_purple = "#8f3f71",
+  dim_purple = "#8f3f71",
-  vivid_aqua = "#427b58",
+  dim_aqua = "#427b58",
-  vivid_orange = "#af3a03",
+  dim_orange = "#af3a03",
   gray = "#928374",
 }
 
@@ -138,15 +138,15 @@ local function get_colors()
     colors.aqua = palette.classic_aqua
     colors.orange = palette.classic_orange
     colors.gray = palette.gray
-  elseif config.contrast == "vivid" then
+  elseif config.contrast == "dim" then
-    colors.foreground = palette.vivid_foreground
+    colors.foreground = palette.dim_foreground
-    colors.red = palette.vivid_red
+    colors.red = palette.dim_red
-    colors.green = palette.vivid_green
+    colors.green = palette.dim_green
-    colors.yellow = palette.vivid_yellow
+    colors.yellow = palette.dim_yellow
-    colors.blue = palette.vivid_blue
+    colors.blue = palette.dim_blue
-    colors.purple = palette.vivid_purple
+    colors.purple = palette.dim_purple
-    colors.aqua = palette.vivid_aqua
+    colors.aqua = palette.dim_aqua
-    colors.orange = palette.vivid_orange
+    colors.orange = palette.dim_orange
     colors.gray = palette.gray
   else  -- base/default
     colors.foreground = palette.base_foreground