Skip to content

Commit 63af186

Browse files
committed
README.md JavaScript doc update
1 parent 40aee14 commit 63af186

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Full documentation at [api.typingdna.com](https://api.typingdna.com)*
44

55
### Usage and description
66
First create an instance of the TypingDNA class. Once it's done, the user typing starts being recorded (as a history of strokes). Whenever you want to get the user's typing pattern you have to invoke .getTypingPattern method described in detail below.
7+
78
**Returns**: Returns the instance of the TypingDNA class (singleton)
9+
810
**Example**
911
```js
1012
var tdna = new TypingDNA();
@@ -25,6 +27,7 @@ Here are the functions available in the TypingDNA class:
2527
This is the main function that outputs the user's typing pattern as a String
2628

2729
**Returns**: A typing pattern in String form
30+
2831
**optionsObject**: An object of the following form {type:Number, text:String, textId:Number, length: Number, extended:Boolean}. Detail table below.
2932

3033
| Param | Type | Description |

0 commit comments

Comments
 (0)