From 014031073657b9ba77020e76104c7d45e13b4121 Mon Sep 17 00:00:00 2001
From: Melker Ulander <melker.ulander@pm.me>
Date: Tue, 5 Mar 2024 08:36:01 +0100
Subject: [PATCH] feat!: set `show_warnings = false` by default

Closes #31
---
 README.md              | 21 +++++++++++++++++----
 lua/modicator/init.lua |  2 +-
 2 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index d17a6a7..6990017 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,13 @@ With [lazy.nvim](https://github.com/folke/lazy.nvim/):
     vim.o.number = true
     vim.o.termguicolors = true
   end,
-  opts = {}
+  opts = {
+    -- Warn if any required option above is missing. May emit false positives
+    -- if some other plugin modifies them, which in that case you can just
+    -- ignore. Feel free to remove this line after you've gotten Modicator to
+    -- work properly.
+    show_warnings = true,
+  }
 }
 ```
 
@@ -53,7 +59,13 @@ use {
     vim.o.termguicolors = true
   end,
   config = function()
-    require('modicator').setup()
+    require('modicator').setup({
+    -- Warn if any required option above is missing. May emit false positives
+    -- if some other plugin modifies them, which in that case you can just
+    -- ignore. Feel free to remove this line after you've gotten Modicator to
+    -- work properly.
+    show_warnings = true,
+  })
   end
 }
 ```
@@ -79,8 +91,9 @@ For more information on how to create a highlight group, see `:help nvim_set_hl`
 
 ```lua
 require('modicator').setup({
-  -- Show warning if any required option is missing
-  show_warnings = true,
+  -- Warn if any required option is missing. May emit false positives if some
+  -- other plugin modifies them, which in that case you can just ignore
+  show_warnings = false,
   highlights = {
     -- Default options for bold/italic
     defaults = {
diff --git a/lua/modicator/init.lua b/lua/modicator/init.lua
index 3ede988..f99502d 100644
--- a/lua/modicator/init.lua
+++ b/lua/modicator/init.lua
@@ -13,7 +13,7 @@ local M = {}
 --- @field integration? { lualine?: ModicatorLualineIntegration }
 local options = {
   --- @type boolean
-  show_warnings = true,
+  show_warnings = false,
   highlights = {
     defaults = {
       bold = false,