feat!: by default dont force any keymaps on the user

BREAKING CHANGE
declancm · Jun 28, 2024 · c90c3f4 · c90c3f4
1 parent 3d8a1e8
commit c90c3f4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -55,15 +55,15 @@ use {
 
 A settings table can be passed into the setup function for custom options.
 
-### Default Settings
+### Default Options
 
 ```lua
 return {
     -- Disable the plugin
     disabled = false,
     keymaps = {
         -- Enable the provided 'basic' keymaps
-        basic = true,
+        basic = false,
         -- Enable the provided 'extra' keymaps
         extra = false,
     },
@@ -92,7 +92,13 @@ return {
 
 ```lua
 require("cinnamon").setup {
-    keymaps = { extra = true }, -- Enable the 'extra' keymaps
+    -- Enable all provided keymaps
+    keymaps = {
+        basic = true,
+        extra = true,
+    },
+    -- Only scroll the window
+    options = { mode = "window" },
 }
 ```
 

diff --git a/lua/cinnamon/config.lua b/lua/cinnamon/config.lua
@@ -3,7 +3,7 @@ local M = {}
 local defaults = {
     disabled = false,
     keymaps = {
-        basic = true,
+        basic = false,
         extra = false,
     },
     options = {