@ptolemy2002/react-mount-effects 1.1.1 → 1.1.3

package/README.md

@@ -1,4 +1,17 @@
-# React Library CRA Template
+# React Mount Effects
+React allows `useEffect(() => {callback()}, [])` to run the callback only on first mount, thus `useEffect(() => callback, [])` only runs on unmounting. However, eslint often complains about this. This library manually suppresses those warnings and exports the hooks for convenience sake.
+
+The hooks are not exported as default, so you can import in one of the following ways:
+```
+//ES6
+import { useMountEffect, useUnmountEffect } from '@ptolemy2002/react-mount-effects';
+//CommonJS
+const { useMountEffect, useUnmountEffect } = require('@ptolemy2002/react-mount-effects');
+```
+
+Both hooks take only one argument, the callback.
+
+## Meta
 This is a React Library Created by Ptolemy2002's [cra-template-react-library](https://www.npmjs.com/package/@ptolemy2002/cra-template-react-library) template in combination with [create-react-app](https://www.npmjs.com/package/create-react-app). It contains methods of building and publishing your library to npm.
 For now, the library makes use of React 18 and does not use TypeScript.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/react-mount-effects",
-    "version": "1.1.1",
+    "version": "1.1.3",
     "main": "index.js",
     "files": [
         "index.js"
@@ -24,7 +24,7 @@
         "url": "https://github.com/Ptolemy2002/react-mount-effects",
         "directory": "lib"
     },
-    "description": "Example of a React library",
+    "description": "Dedicated effect functions for React component mount and unmount",
     "license": "ISC",
     "peerDependencies": {
         "@types/react": "^18.3.3",