diff --git a/README.md b/README.md index 2c30318..1a8c4c7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# damper.mjs +# Damper (debouncer, демпфер) +Execute multiple `function` calls in a `timeout` amount of time just once
+
+You may also know this technology as a "debouncer" (you are free to use any name)
+I prefer "damper", from the word "демпфер" + +## Example +```js +const dampered = damper( + ( + a, // 0 + b, // 1 + c, // 2 + force = false, // 3 + d, // 4 + resolve, + reject + ) => {}, + 500, + 3, // 3 -> the "force" argument +); + +dampered('for a', 'for b', 'for c', true, 'for d'); // Enabled forced execution + ``` \ No newline at end of file