Merge pull request #35 from dhershman1/development

Fixed unclear documentation

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## v2.5.3
+
+### Fixed
+
+- Unclear documentation on using the `debounce` function [#34](https://github.com/dhershman1/vue-debounce/issues/34)
+
 ## v2.5.2
 
 ### Improved

README.md

@@ -167,12 +167,14 @@ Simply require the debounce file.
 import { debounce } from 'vue-debounce'
 ```
 
-And then you can use it as a function like so:
+The `debounce` function returns a function back which in turn is debounced, so you can set them up ahead of time, or just double call the function like so:
 
 ```js
-debounce(() => console.log('normal format'), '400ms')
+const dFn = debounce(val => console.log('normal format', val), '400ms')
+
+dFn(10) // => 'normal format' 10
 // Or
-debounce(() => console.log('just a number!'), 400)
+debounce(val => console.log('just a number!'), 400)(10) // => 'just a number!' 10
 ```
 
 ## Typescript Support

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-debounce",
-  "version": "2.5.2",
+  "version": "2.5.3",
   "description": "A simple vue directive for debounce",
   "main": "dist/vue-debounce.min.js",
   "types": "types/index.d.ts",