refactor(project): change name due to issues with NPM

Author: olavoparno

CHANGELOG.md

@@ -2,4 +2,4 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [1.0.0](https://github.com/olavoparno/react-use-script/compare/v1.0.6...v1.0.0) (2020-08-13)
+## [1.0.0](https://github.com/olavoparno/react-use-scripts/compare/v1.0.6...v1.0.0) (2020-08-13)

README.md

@@ -1,8 +1,8 @@
-# react-use-script
+# react-use-scripts
 
-> Appends script tags to the document with ease
+> Appends script tags to the document as functions or components with ease
 
-[![NPM](https://img.shields.io/npm/v/react-use-script.svg)](https://www.npmjs.com/package/react-use-script)
+[![NPM](https://img.shields.io/npm/v/react-use-scripts.svg)](https://www.npmjs.com/package/react-use-scripts)
 
 ---
 
@@ -18,7 +18,7 @@
 ## Install
 
 ```bash
-npm install --save react-use-script
+npm install --save react-use-scripts
 ```
 
 ---
@@ -29,7 +29,7 @@ npm install --save react-use-script
 
 ```tsx
 import * as React from 'react';
-import { useScript } from 'react-use-script';
+import { useScript } from 'react-use-scripts';
 
 const App = () => {
   const { ScriptLoader } = useScript();
@@ -52,7 +52,7 @@ const App = () => {
 
 ```tsx
 import * as React from 'react';
-import { useScript } from 'react-use-script';
+import { useScript } from 'react-use-scripts';
 
 const App = () => {
   const { appendScript } = useScript();
@@ -77,67 +77,65 @@ const App = () => {
 
 ## Documentation
 
-`useScript()` returns:
-
-1. <ScriptLoader />
-
-- Props
-
-```tsx
-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
-
-```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;
-```
-
-2. appendScript()
-
-- Props
-
-```tsx
-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
-};
-```
-
-- Default Props
-
-```tsx
-id: undefined;
-scriptText: undefined;
-optionalCallback = () => null;
-htmlPart = 'head';
-otherProps = {};
-```
+- `useScript()` returns:
+
+  - ScriptLoader as component
+  - Props:
+
+  ```tsx
+  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:
+
+  ```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;
+  ```
+
+  - appendScript()
+  - Props:
+
+  ```tsx
+  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
+  };
+  ```
+
+  - Default Props:
+
+  ```tsx
+  id: undefined;
+  scriptText: undefined;
+  optionalCallback = () => null;
+  htmlPart = 'head';
+  otherProps = {};
+  ```
 
 ---
 
 ## License
 
-react-use-script is [MIT licensed](./LICENSE).
+react-use-scripts is [MIT licensed](./LICENSE).
 
 ---
 

package-lock.json

@@ -1,12 +1,12 @@
 {
-  "name": "react-use-script",
+  "name": "react-use-scripts",
   "version": "1.0.0",
-  "description": "Appends script tags to the document",
+  "description": "Appends script tags to the document as functions or components with ease",
   "author": "Olavo Parno",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git://github.com/olavoparno/react-use-script.git"
+    "url": "git://github.com/olavoparno/react-use-scripts.git"
   },
   "main": "dist/index.js",
   "module": "dist/index.es.js",