docs(project): update docs and naming

Author: olavoparno

README.md

@@ -1,6 +1,6 @@
 # react-use-hotjar
 
-> Add [Hotjar](https://www.hotjar.com/) capabilities as custom hooks to your project
+> Adds [Hotjar](https://www.hotjar.com/) capabilities as custom hooks to your project
 
 [![NPM](https://img.shields.io/npm/v/react-use-hotjar.svg)](https://www.npmjs.com/package/react-use-hotjar)
 
@@ -25,7 +25,7 @@ npm install --save react-use-hotjar
 
 ## Usage
 
-- Initializing Hotjar
+- Initializing Hotjar (use it at your very `index.jsx`)
 
 ```tsx
 import * as React from 'react';
@@ -45,7 +45,7 @@ const HotjarReadyApp = () => {
 };
 ```
 
-- Identifying Users
+- Identifying Users (use it wherever you get access to user's information)
 
 ```tsx
 const MyCustomComponent = () => {
@@ -54,7 +54,7 @@ const MyCustomComponent = () => {
   const handleUserInfo = (userInfo) => {
     const { id, ...restUserInfo } = userInfo;
 
-    identityHotjar(
+    identifyHotjar(
       id,
       JSON.stringify({
         restUserInfo,
@@ -84,14 +84,14 @@ initHotjar: (
 ) => boolean;
 ```
 
-- identityHotjar()
+- identifyHotjar()
 
 1. `userId`: Unique user's identification as string
 2. `userInfo`: Stringfied user info of key-value pairs (note this must not be so long and deep according to [docs](https://help.hotjar.com/hc/en-us/articles/360033640653-Identify-API-Reference))
 3. `logCallback`: Optional callback for logging wether Hotjar identified user or not
 
 ```tsx
-identityHotjar: (userId: string, userInfo: string, logCallback?: () => void) =>
+identifyHotjar: (userId: string, userInfo: string, logCallback?: () => void) =>
   boolean;
 ```
 

src/index.tsx

@@ -7,7 +7,7 @@ type TUseHotjar = {
     hotjarVersion: string,
     logCallback?: () => void
   ) => boolean;
-  identityHotjar: (
+  identifyHotjar: (
     userId: string,
     userInfo: string,
     logCallback?: () => void
@@ -30,13 +30,13 @@ export function useHotjar(): TUseHotjar {
     [appendHeadScript]
   );
 
-  const identityHotjar = React.useCallback(
+  const identifyHotjar = React.useCallback(
     (userId: string, userInfo: string, loggerFunction): boolean => {
       try {
-        const hotjarIdentityScript = `var userId="${userId}" || null;window.hj("identify",userId,${userInfo});`;
+        const hotjarIdentifyScript = `var userId="${userId}" || null;window.hj("identify",userId,${userInfo});`;
         const isIdentified = appendHeadScript(
-          hotjarIdentityScript,
-          'identity-script'
+          hotjarIdentifyScript,
+          'identify-script'
         );
 
         if (loggerFunction && typeof loggerFunction === 'function')
@@ -52,8 +52,8 @@ export function useHotjar(): TUseHotjar {
     [appendHeadScript]
   );
 
-  return React.useMemo(() => ({ initHotjar, identityHotjar }), [
+  return React.useMemo(() => ({ initHotjar, identifyHotjar }), [
     initHotjar,
-    identityHotjar,
+    identifyHotjar,
   ]);
 }