diff --git a/README.md b/README.md index dff2caf..11e7be4 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,31 @@ require('specs').setup{ show_jumps = true, min_jump = 30, popup = { - delay_ms = 0, - inc_ms = 10, - blend = 10, + delay_ms = 0, -- delay before popup displays + inc_ms = 10, -- time increments used for fade/resize effects + blend = 10, -- starting blend, between 0-100 (fully transparent), see :h winblend width = 10, fader = require('specs').linear_fader, resizer = require('specs').shrink_resizer } } ``` +You can implement your own custom fader/resizer functions for some pretty cool effects: +```lua +require('specs').setup{ + popup = { + -- Simple constant blend effect + fader = function(blend, cnt) + if cnt > 100 then + return 80 + else return nil end + end, + -- Growing effect from left to right + resizer = function(width, ccol, cnt) + if width-cnt > 0 then + return {width+cnt, ccol} + else return nil end + end, + } +} +```