Merge pull request #4 from timmypidashev/3-feature-request-customize-colors

v1.0.0

Author: timmypidashev

.github/darkbox.png

@@ -0,0 +1,25 @@
+on:
+  push:
+    branches:
+      - main
+name: docs
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: gruvbox.nvim
+          version: "Neovim >= 0.8.0"
+          demojify: true
+          treesitter: true
+      - name: Push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "auto-generate vimdoc"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

.github/screenshot.png

@@ -0,0 +1,24 @@
+---
+on: [push, pull_request]
+name: default
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        nvim-versions: ["stable", "nightly"]
+    name: test
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.nvim-versions }}
+
+      - name: run tests
+        run: make test
+        env:
+          PLENARY_DIR: vendor/plenary.nvim

.github/screenshot_classic.png

@@ -0,0 +1,11 @@
+TESTS_INIT=tests/init.lua
+TESTS_DIR=tests/
+
+.PHONY: test
+
+test:
+	@nvim \
+		--headless \
+		--noplugin \
+		-u ${TESTS_INIT} \
+		-c "PlenaryBustedDirectory ${TESTS_DIR} { minimal_init = '${TESTS_INIT}' }"

.github/screenshot_dim.png

@@ -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
+
+### Classic
+![Screenshot](.github/screenshot_classic.png)
+
+### Retro 
+![Screenshot](.github/screenshot_retro.png)
+
+### Dim
+![Screenshot](.github/screenshot_dim.png)
+
 ## 🚀 Installation
 
 ### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
@@ -25,9 +36,54 @@ return {
 }
 ```
 
-## 📸 Screenshot
+## ✏️ Configuration
+
+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 "retro", "dim" or empty string for classic
+  palette_overrides = {},
+  overrides = {},
+  dim_inactive = false,
+  transparent_mode = false,
+})
+vim.cmd("colorscheme darkbox")
+```
 
-![Screenshot](.github/screenshot.png)
+**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