docs: fix README

Author: rachartier

README.md

@@ -2,6 +2,8 @@
 
 A tiny Neovim plugin that adds subtle animations to various operations.
 
+**Do not forget to enable animations on operations you want to animate ! A lot of operations are disabled by default.**
+
 ![Neovim version](https://img.shields.io/badge/Neovim-0.10+-blueviolet.svg)
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
@@ -21,19 +23,22 @@ https://github.com/user-attachments/assets/6bc98a8f-8b7e-4b57-958a-74ad5372612f
 
 ### Undo/Redo support
 ![tiny_glimmer_demo_undo_redo](https://github.com/user-attachments/assets/6e980884-b425-42d2-a179-6c6126196bd5)
+- Smooth animations for various operations:
+  - Yank and paste
+  - Search navigation
+  - Undo/redo operations
+  - Custom operations support
+
+Built-in animation styles:
+- `fade`: Smooth fade in/out transition
+- `reverse_fade`: Reverse fade effect with outBack easing
+- `bounce`: Bouncing highlight effect
+- `left_to_right`: Linear left-to-right sweep
+- `pulse`: Pulsating highlight
+- `rainbow`: Rainbow color transition
+- `custom`: Define your own animation logic
 
 
-
-- Smooth animations for yank operations
-- Multiple animation styles:
-  - `fade`: Simple fade in/out effect
-  - `reverse_fade`: Reverse fade in/out effect
-  - `bounce`: Bouncing transition
-  - `left_to_right`: Linear left-to-right animation
-  - `pulse`: Pulsating highlight effect
-  - `rainbow`: Rainbow transition
-  - `custom`: Custom animation that you can define
-
 ## 📋 Requirements
 
 - Neovim >= 0.10
@@ -71,13 +76,13 @@ require('tiny-glimmer').setup({
     -- Disable this if you wants to debug highlighting issues
     disable_warnings = true,
 
-    refresh_interval_ms = 6,
+    refresh_interval_ms = 8,
 
     overwrite = {
         -- Automatically map keys to overwrite operations
         -- If set to false, you will need to call the API functions to trigger the animations
         -- WARN: You should disable this if you have already mapped these keys
-        -- 		 or if you want to use the API functions to trigger the animations
+        --        or if you want to use the API functions to trigger the animations
         auto_map = true,
 
         -- For search and paste, you can easily modify the animation to suit your needs
@@ -97,14 +102,18 @@ require('tiny-glimmer').setup({
         --
         -- All "mapping" can be set in 2 ways:
         -- 1. A string with the key you want to map
-        -- 		  Example:
-        -- 			paste_mapping = "p"
+        --    Example:
+        --    paste_mapping = "p"
         -- 2. A table with the key you want to map and its actions
-        -- 		  Example:
-        -- 			paste_mapping = {
-        -- 				lhs = "p"
-        -- 				rhs = "<Plug>(YankyPutAfter)"
-        --      }
+        --    Example:
+        --    paste_mapping = {
+        --        lhs = "p"
+        --        rhs = "<Plug>(YankyPutAfter)"
+        --    }
+        yank = {
+              enabled = true,
+              default_animation = "fade",
+        },
         search = {
             enabled = false,
             default_animation = "pulse",
@@ -115,12 +124,8 @@ require('tiny-glimmer').setup({
             -- Keys to navigate to the previous match
             prev_mapping = "Nzzzv",
         },
-        yank = {
-          	enabled = true,
-          	default_animation = "fade",
-        },
         paste = {
-            enabled = false,
+            enabled = true,
             default_animation = "reverse_fade",
 
             -- Keys to paste
@@ -162,7 +167,6 @@ require('tiny-glimmer').setup({
         },
     },
 
-
     support = {
         -- Enable support for gbprod/substitute.nvim
         -- You can use it like so:
@@ -180,7 +184,6 @@ require('tiny-glimmer').setup({
         },
     },
 
-
     -- Animations for other operations
     presets = {
         -- Enable animation on cursorline when an event in `on_events` is triggered
@@ -205,41 +208,57 @@ require('tiny-glimmer').setup({
     -- Only use if you have a transparent background
     -- It will override the highlight group background color for `to_color` in all animations
     transparency_color = nil,
+     -- Animation configurations
     animations = {
         fade = {
             max_duration = 400,
             min_duration = 300,
             easing = "outQuad",
             chars_for_max_duration = 10,
+            from_color = "Visual", -- Highlight group or hex color
+            to_color = "Normal", -- Same as above
         },
         reverse_fade = {
             max_duration = 380,
             min_duration = 300,
             easing = "outBack",
             chars_for_max_duration = 10,
+            from_color = "Visual",
+            to_color = "Normal",
         },
         bounce = {
             max_duration = 500,
             min_duration = 400,
             chars_for_max_duration = 20,
             oscillation_count = 1,
+            from_color = "Visual",
+            to_color = "Normal",
         },
         left_to_right = {
             max_duration = 350,
             min_duration = 350,
             min_progress = 0.85,
             chars_for_max_duration = 25,
             lingering_time = 50,
+            from_color = "Visual",
+            to_color = "Normal",
         },
         pulse = {
             max_duration = 600,
             min_duration = 400,
             chars_for_max_duration = 15,
             pulse_count = 2,
             intensity = 1.2,
+            from_color = "Visual",
+            to_color = "Normal",
+        },
+        rainbow = {
+            max_duration = 600,
+            min_duration = 350,
+            chars_for_max_duration = 20,
         },
 
-				-- You can add as many animations as you want
+        -- You can add as many animations as you want
         custom = {
             -- You can also add as many custom options as you want
             -- Only `max_duration` and `chars_for_max_duration` is required
@@ -351,25 +370,14 @@ Each animation type has its own configuration options:
 
 - `:TinyGlimmer enable` - Enable animations
 - `:TinyGlimmer disable` - Disable animations
-- `:TinyGlimmer fade` - Switch to fade animation
-- `:TinyGlimmer reverse_fade` - Switch to reverse fade animation
-- `:TinyGlimmer bounce` - Switch to bounce animation
-- `:TinyGlimmer left_to_right` - Switch to left-to-right animation
-- `:TinyGlimmer pulse` - Switch to pulse animation
-- `:TinyGlimmer rainbow` - Switch to rainbow animation
-- `:TinyGlimmer custom` - Switch to your custom animation
+- `:TinyGlimmer <animation>` - Switch animation style
+  - Supported: fade, reverse_fade, bounce, left_to_right, pulse, rainbow, custom
 
 ## 🛠️ API
-
 ```lua
--- Enable animations
-require('tiny-glimmer').enable()
-
--- Disable animations
-require('tiny-glimmer').disable()
-
--- Toggle animations
-require('tiny-glimmer').toggle()
+require('tiny-glimmer').enable()  -- Enable animations
+require('tiny-glimmer').disable() -- Disable animations
+require('tiny-glimmer').toggle()  -- Toggle animations
 
 --- Change highlight
 --- @param animation_name string|string[] The animation name. Can be a string or a table of strings.
@@ -391,66 +399,24 @@ require('tiny-glimmer').search_under_cursor() -- Same as `*`
 -- When overwrite.paste.enabled is true
 require('tiny-glimmer').paste() -- Same as `p`
 require('tiny-glimmer').Paste() -- Same as `P`
-```
 
-### Keymaps
-> [!INFO]
-> If you have `overwrite.auto_map` set to `true`, you don't need to set these keymaps.
-
-Configuration example with overwrites enabled:
-```lua
-{
-    "rachartier/tiny-glimmer.nvim",
-    event = "VeryLazy",
-    keys = {
-        {
-            "n",
-            function()
-                require("tiny-glimmer").search_next()
-            end,
-            { noremap = true, silent = true },
-        },
-        {
-            "N",
-            function()
-                require("tiny-glimmer").search_prev()
-            end,
-            { noremap = true, silent = true },
-        },
-        {
-            "p",
-            function()
-                require("tiny-glimmer").paste()
-            end,
-            { noremap = true, silent = true },
-        },
-        {
-            "P",
-            function()
-                require("tiny-glimmer").Paste()
-            end,
-            { noremap = true, silent = true },
-        },
-        {
-            "*",
-            function()
-                require("tiny-glimmer").search_under_cursor()
-            end,
-            { noremap = true, silent = true },
-        }
-    },
-    opts = {},
-}
+-- Undo operations (requires undo.enabled = true)
+require('tiny-glimmer').undo()   -- Undo changes
+require('tiny-glimmer').redo()   -- Redo changes
 ```
+
 ## ❓FAQ
 
 ### Why is there two animations playing at the same time?
 You should disable your own `TextYankPost` autocmd that calls `vim.highlight.on_yank`
 
+### Transparent background issues?
+Set the `transparency_color` option to your desired background color.
 
 ## Thanks
 
-- [EmmanuelOga/easing](https://github.com/EmmanuelOga) for the easing functions
+- [EmmanuelOga/easing](https://github.com/EmmanuelOga) - Easing function implementations
+- [tzachar/highlight-undo.nvim](https://github.com/tzachar/highlight-undo.nvim) - Inspiration for hijack function
 
 ## 📝 License
 

lua/tiny-glimmer/init.lua

@@ -102,7 +102,7 @@ M.config = {
 		},
 	},
 
-	refresh_interval_ms = 6,
+	refresh_interval_ms = 8,
 	transparency_color = nil,
 
 	animations = {