diff --git a/README.md b/README.md index 5c76c3e..2193335 100644 --- a/README.md +++ b/README.md @@ -13,23 +13,6 @@ designed for use with terminal and gui applications. ![Component 1](https://github.com/user-attachments/assets/11d8bd97-0f99-4413-937a-a5eaf4b2a4db) -autumn - -![autumn](https://github.com/user-attachments/assets/bcc3cd16-a613-42ac-a74a-69a4da8a866a) - -spring - -![spring](https://github.com/user-attachments/assets/eb84a3d3-faa3-48b7-b52e-6728d6d65801) - -winter - -![winter](https://github.com/user-attachments/assets/7ae41baa-8916-4612-8468-0579b93aee72) - -summer - -![summer](https://github.com/user-attachments/assets/3ea208ac-abd0-4386-85a3-032c11547cb5) - - - [Features](#features) @@ -42,6 +25,7 @@ summer - [Docs](#docs) - [Commands](#commands) - [Default Config](#default-config) +- [Config Variant](#config-transparency) - [Config Transparency](#config-transparency) - [Config Styles](#config-styles) - [Config Highlights](#config-highlights) @@ -233,6 +217,18 @@ require('solarized').setup({ vim.cmd.colorscheme = 'solarized' ``` +## Config Variants + +Solarized includes four variants: spring, summer, autumn, and winter. + +[preview](https://github.com/maxmx03/solarized.nvim/blob/main/VARIANTS.md) + +```lua +require('solarized').setup { + variant = 'winter', -- "spring" | "summer" | "autumn" | "winter" (default) +} +``` + ## Config Transparency By default, transparency is turned off, but you can easily enable it and diff --git a/VARIANTS.md b/VARIANTS.md new file mode 100644 index 0000000..2952cfa --- /dev/null +++ b/VARIANTS.md @@ -0,0 +1,17 @@ +# Variants + +autumn + +![autumn](https://github.com/user-attachments/assets/bcc3cd16-a613-42ac-a74a-69a4da8a866a) + +spring + +![spring](https://github.com/user-attachments/assets/eb84a3d3-faa3-48b7-b52e-6728d6d65801) + +winter + +![winter](https://github.com/user-attachments/assets/7ae41baa-8916-4612-8468-0579b93aee72) + +summer + +![summer](https://github.com/user-attachments/assets/3ea208ac-abd0-4386-85a3-032c11547cb5)