docs

Author: aldrinpvincent

README.md

@@ -1,6 +1,6 @@
 # react-use-custom-hooks
 
-A collection of react custom hooks
+A collection of react custom hooks in typescript
 
 # Installation
 
@@ -15,9 +15,6 @@ yarn add react-use-custom-hooks
 import { useSafeState } from 'react-use-custom-hooks';
 ```
 
-# Hooks list
+# Demo
 
-1. useDebounce
-2. useSafeState
-3. useIsMounted
-4. usePrevious
+https://react-use-custom-hooks.vercel.app/

docs/docs/usePrevious.md

@@ -7,7 +7,7 @@ If you want to access the previous props or state in functional components, you
 ### Usage example
 
 ```typescript
-const [value, setvalue] = useState(initialState);
+const [value, setValue] = useState(initialState);
 const previousValue = usePrevious(value);
 ```
 

docs/docs/useSafeState.md

@@ -1,17 +1,19 @@
 # useSafeState
 
-A memory safe version of react's `useState` hook. In react, on way memory leak occurs when `setState` operation performed on an unmounted component and it happens mostly with asynchronous opration like AJAX calls.
+A memory safe version of react's `useState` hook. In react, on way memory leak occurs when `setState` operation performed on an unmounted component and it happens mostly with asynchronous operation like AJAX calls.
 
-For example, if the user initiated an AJAX call and navigated away from tha page before the call is returned, the component will get unmounted and when the api call is fulfilled, the `setstate` will be performed on the unmounted component causing a memory leak.
+For example, if the user initiated an AJAX call and navigated away from tha page before the call is returned, the component will get unmounted and when the api call is fulfilled, the `setState` will be performed on the unmounted component causing a memory leak.
 
-This hook will prevent these kind of memory leaks by checking whether the component is mounted before `setstate` operation, if the component is unmounted, it will jsut ignore the `setstate` call. The API is same as react's `useState` hook, so you can use this hook instead of `useState` for asynchronous opration to avoid any memory leak.
+For small applications, leaking memory might not be a big issue since there is not much client side navigation happening and the memory will get cleared on reload. But for large applications, especially large single page applications, it can be a problem since the user navigates to multiple pages of the application over time without reloading the app and thus if there is any leak it will grew over time causing the app to break eventually.
+
+This hook will prevent these kind of memory leaks by checking whether the component is mounted before `setState` operation, if the component is unmounted, it will just ignore the `setState` call. The API is same as react's `useState` hook, so you can use this hook instead of `useState` for asynchronous operation to avoid any memory leak.
 
 <pre>{`import {useSafeState} from 'react-use-custom-hooks';`}</pre>
 
 ### Usage example
 
 ```typescript
-const [value, setvalue] = useSafeState(initialState);
+const [value, setValue] = useSafeState(initialState);
 ```
 
 ### Playground

package.json

@@ -14,6 +14,7 @@
     "type": "git",
     "url": "https://github.com/aldrinpvincent/react-use-custom-hooks"
   },
+  "homepage": "https://react-use-custom-hooks.vercel.app/",
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
@@ -40,7 +41,7 @@
   "name": "react-use-custom-hooks",
   "author": "aldrinpvincent",
   "module": "dist/react-custom-hooks.esm.js",
-  "description": "A collection of react custom hooks in typescript",
+  "description": "A utility to cache api calls in JavaScript by memoizing promises",
   "size-limit": [
     {
       "path": "dist/react-custom-hooks.cjs.production.min.js",