Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TA3 authored Jun 25, 2024
1 parent cfefb9c commit 5f2fc3a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ This Javascript Library allows to track user's behaviour by recording mouse acti
- Timestamp
- Scroll
- Time on page
- Window Resize
- Visibility Change


## 🏁 Installation <a name = "install"></a>
Expand Down Expand Up @@ -62,6 +64,8 @@ If no configuration was passes the libray will use the default configuration:
mouseMovementInterval: 1,
mouseScroll: true,
timeCount: true,
windowResize: true,
visibilitychange: true,
clearAfterProcess: true,
processTime: 15,
processData: function(results){
Expand All @@ -77,6 +81,8 @@ If no configuration was passes the libray will use the default configuration:
| mouseMovementInterval | time between tracking mouse movements | int (seconds) | 1 |
| mouseScroll | track mouse scroll | bool | true |
| timeCount | track time | bool | true |
| windowResize | window resize | bool | true |
| visibilitychange | track visibility of the tab's content | bool | true |
| clearAfterProcess | clear results object after processing the data | bool | true |
| processTime | time between processing the data automatically <br>(false will enable manual only data processing) | int/bool (seconds) | 15 |
| processData | function that processes the results object | function | ... |
Expand Down

0 comments on commit 5f2fc3a

Please sign in to comment.