docs(readme): update readme

Author: olavoparno

README.md

@@ -18,88 +18,126 @@
 ## Install
 
 ```bash
-npm install --save react-use-hotjar
+npm install --save react-use-script
 ```
 
 ---
 
 ## Usage
 
-- Initializing Hotjar (use it at your very `index.jsx`)
+- Use script tags in your **JSX**
 
 ```tsx
 import * as React from 'react';
+import { useScript } from 'react-use-script';
+
+const App = () => {
+  const { ScriptLoader } = useScript();
+
+  return (
+    <div>
+      <ScriptLoader
+        id="custom-script"
+        src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"
+        delayMs={0}
+        onCreate={() => console.log('created!')}
+        type="text/javascript"
+      />
+    </div>
+  );
+};
+```
 
-import { useHotjar } from 'react-use-hotjar';
+- Append scripts to the document programmatically
 
-const myCustomLogger = console.info;
+```tsx
+import * as React from 'react';
+import { useScript } from 'react-use-script';
 
-const HotjarReadyApp = () => {
-  const { initHotjar } = useHotjar();
+const App = () => {
+  const { appendScript } = useScript();
 
   React.useEffect(() => {
-    initHotjar(hotjarId, hotjarVersion, myCustomLogger);
-  });
-
-  return <App />;
+    appendScript({
+      id: 'script-append',
+      scriptText: "console.log('my script has been called')",
+      optionalCallback: console.log('optional callback'),
+    });
+  }, [appendScript]);
+
+  return (
+    <div>
+      <h1>Script appended to the head programmatically!</h1>
+    </div>
+  );
 };
 ```
 
-- Identifying Users (use it wherever you get access to user's information)
+---
+
+## Documentation
+
+`useScript()` returns:
+
+1. <ScriptLoader />
+
+- Props
 
 ```tsx
-const MyCustomComponent = () => {
-  const { initHotjar } = useHotjar();
-
-  const handleUserInfo = (userInfo) => {
-    const { id, ...restUserInfo } = userInfo;
-
-    identifyHotjar(
-      id,
-      JSON.stringify({
-        restUserInfo,
-      })
-    );
-  };
+type ScriptLoader = {
+  onCreate?: (() => null) | undefined; // runs after script tag rendering
+  onLoad?: (() => null) | undefined; // runs on script load
+  onError?: ((e: any) => never) | undefined; // runs on script error
+  delayMs?: number | undefined; // run with delayed start
+  htmlPart?: string | undefined; // choose where to append, HEAD or BODY
+  src: string; // script file source path
+  otherProps?: Record<string, unknown> | undefined; // html script tag properties
 };
 ```
 
----
+- Default Props
 
-## Documentation
-
-`useHotjar()` returns:
+```tsx
+src: undefined;
+onCreate = () => null;
+onLoad = () => null;
+onError = (e) => {
+  throw new URIError(`The script ${e.target.src} is not accessible`);
+};
+delayMs = 0;
+htmlPart = 'head';
+otherProps: undefined;
+```
 
-- initHotjar()
+2. appendScript()
 
-1. `hotjarId`: Your Hotjar application ID ex.: 1933331
-2. `hotjarVersion`: Hotjar's current version ex.: 6
-3. `logCallback`: Optional callback for logging wether Hotjar is ready or not
+- Props
 
 ```tsx
-initHotjar: (
-  hotjarId: string,
-  hotjarVersion: string,
-  logCallback?: () => void
-) => boolean;
+type AppendScript = {
+  id: string; // script id
+  scriptText: string; // script code as string
+  optionalCallback?: (() => null) | undefined; // optional callback function after running
+  htmlPart: string; // choose where to append, HEAD or BODY
+  otherProps?: Record<string, unknown> | undefined; // html script tag properties
+};
 ```
 
-- 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
+- Default Props
 
 ```tsx
-identifyHotjar: (userId: string, userInfo: string, logCallback?: () => void) =>
-  boolean;
+id: undefined;
+scriptText: undefined;
+optionalCallback = () => null;
+htmlPart = 'head';
+otherProps = {};
 ```
 
 ---
 
 ## License
 
-react-use-hotjar is [MIT licensed](./LICENSE).
+react-use-script is [MIT licensed](./LICENSE).
 
 ---
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-use-script",
-  "version": "1.0.6",
+  "version": "1.0.0",
   "description": "Appends script tags to the document",
   "author": "Olavo Parno",
   "license": "MIT",