added userInfo option and better methods

Author: Taha

README.md

@@ -1,5 +1,5 @@
 <h3 align="center">User Behaviour Tracking</h3>
-<h4 align="center">4.0 KB</h4>
+<h4 align="center">2.7 KB</h4>
 
 <div align="center">
 
@@ -20,6 +20,7 @@
 - [About](#about)
 - [Installation](#install)
 - [Configuration](#config)
+- [Methods](#methods)
 - [Tracking](#tracking)
 - [Results](#results)
 
@@ -55,6 +56,7 @@ userBehaviour.config({.....});
 If no configuration was passes the libray will use the default configuration:
 ```javascript
 {
+    userInfo: true,
     clicks: true,
     mouseMovement: true,
     mouseMovementInterval: 1,
@@ -67,18 +69,30 @@ If no configuration was passes the libray will use the default configuration:
     },
 }
 ```
-| Config Key            | Description                                                                                        | Type               | Default |   |   |
-|-----------------------|----------------------------------------------------------------------------------------------------|--------------------|---------|---|---|
-| clicks                | track mouse clicks                                                                                 | bool               | true    |   |   |
-| mouseMovement         | track mouse movement                                                                               | bool               | true    |   |   |
-| mouseMovementInterval | time between tracking mouse movements                                                              | int (seconds)      | 1       |   |   |
-| mouseScroll           | track mouse scroll                                                                                 | bool               | true    |   |   |
-| timeCount             | track time                                                                                         | 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           | ...     |   |   |
-
-
+| Config Key            | Description                                                                                        | Type               | Default |
+|-----------------------|----------------------------------------------------------------------------------------------------|--------------------|---------|
+| userInfo              | record browser/device details                                                                      | bool               | true    |
+| clicks                | track mouse clicks                                                                                 | bool               | true    |
+| mouseMovement         | track mouse movement                                                                               | bool               | true    |
+| mouseMovementInterval | time between tracking mouse movements                                                              | int (seconds)      | 1       |
+| mouseScroll           | track mouse scroll                                                                                 | bool               | true    |
+| timeCount             | track time                                                                                         | 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           | ...     |
+
+## 📚 Methods <a name="methods"></a>
+
+This is  a list of all available methods that can be called:
+
+| Method         | Description                              | Example                             |
+|----------------|------------------------------------------|-------------------------------------|
+| showConfig     | returns current config                   | userBehaviour.showConfig()          |
+| config         | sets the configuration                   | userBehaviour.config(config_object) |
+| start          | starts tracking                          | userBehaviour.start()               |
+| stop           | stops tracking                           | userBehaviour.stop()                |
+| showResult     | returns current result                   | userBehaviour.showResult()          |
+| processResults | calls the process function set in config | userBehaviour.processResults()      |
 
 ## 🚀 Tracking <a name = "tracking"></a>
 

userBehaviour.js

@@ -1,5 +1,10 @@
+/**
+ * @author Taha Al-Jody <taha@ta3design.com>
+ * https://github.com/TA3/web-user-behaviour
+ */
 var userBehaviour = (function(){
     var defaults = {
+        userInfo: true,
         clicks: true,
         mouseMovement: true,
         mouseMovementInterval: 1,
@@ -113,15 +118,15 @@ var userBehaviour = (function(){
         //PROCESS INTERVAL
         if(user_config.processTime !== false){
             mem.processInterval = setInterval(()=>{
-                user_config.processData(results);
-                if (user_config.clearAfterProcess) {
-                    resetResults();
-                }
+                user_config.processData(result());
             },user_config.processTime*1000)
         }
     };
     function processResults(){
-        user_config.processData(results);
+        user_config.processData(result());
+        if (user_config.clearAfterProcess) {
+            resetResults();
+        }
     }
     function stop(){
         if(user_config.processTime !== false){
@@ -133,13 +138,24 @@ var userBehaviour = (function(){
         window.removeEventListener("mousemove", mem.eventsFunctions.mouseMovement);
     }
     function result(){
+        if (user_config.userInfo === false && userBehaviour.showResult().userInfo !== undefined) {
+            delete userBehaviour.showResult().userInfo;
+        }
         if(user_config.time.timeCount !== undefined && user_config.time.timeCount){
             results.time.currentTime = getTimeStamp();
         }
         return results
     };
+    function showConfig(){
+        if (Object.keys(user_config).length !== Object.keys(defaults).length) {
+            return defaults;
+        }
+        else{
+            return user_config;
+        }
+    };
     return {
-        showConfig: user_config,
+        showConfig: showConfig,
         config: config,
         start: start,
         stop: stop,