auxin - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

package.json

 {
   "name": "auxin",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "The Utility Toolkit npm package is a comprehensive collection of utility functions designed to streamline common tasks in Node.js development. Whether you're working on string manipulation, array operations, date/time formatting, or other general-purpose tasks, this toolkit has you covered.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,13 +0,46 @@
-**Utility Toolkit**
+# Utility Toolkit
 
 The Utility Toolkit npm package is a comprehensive collection of utility functions designed to streamline common tasks in Node.js development. Whether you're working on string manipulation, array operations, date/time formatting, or other general-purpose tasks, this toolkit has you covered.
 
-Key Features:
-- **String Manipulation**: Simplify string operations such as concatenation, trimming, case conversion, and more with a variety of utility functions.
-- **Array Operations**: Perform common array manipulations like filtering, mapping, sorting, and searching efficiently and effectively.
-- **Date/Time Formatting**: Format dates and times according to various formats, time zones, and locales with ease, ensuring consistency and accuracy in your applications.
-- **Error Handling**: Handle errors gracefully with utility functions for validating inputs, catching exceptions, and logging errors to facilitate debugging.
-- **Math Functions**: Access a range of mathematical functions for performing calculations, generating random numbers, and solving common mathematical problems.
-- **File System Operations**: Simplify file system interactions with utilities for reading, writing, copying, moving, and deleting files and directories.
+## Installation
 
-With well-documented APIs and thorough testing, the Utility Toolkit npm package aims to provide developers with a reliable and efficient set of tools to enhance their Node.js projects. Whether you're building web applications, command-line utilities, or backend services, this toolkit is a valuable resource for accelerating development and improving code quality.
+You can install the Utility Toolkit npm package via npm:
+
+```bash
+npm install auxin
+```
+
+## Usage
+
+To use the Utility Toolkit in your Node.js project, simply import the desired utility functions from the package:
+
+```typescript
+import { arrayUtils, stringUtils, dateUtils } from 'auxin';
+
+// Example usage of arrayUtils
+const arr = [1, 2, 3, 4, 5];
+const filteredArr = arrayUtils.filterArray(arr, num => num % 2 === 0);
+console.log(filteredArr); // Output: [2, 4]
+
+// Example usage of stringUtils
+const str = 'Hello, World!';
+const reversedStr = stringUtils.reverseString(str);
+console.log(reversedStr); // Output: '!dlroW ,olleH'
+
+// Example usage of dateUtils
+const currentDate = new Date();
+const formattedDate = dateUtils.formatDate(currentDate, 'yyyy-MM-dd');
+console.log(formattedDate); // Output: '2024-04-21'
+```
+
+## Documentation
+
+For detailed documentation on the available utility functions and their usage, please refer to the [documentation](docs/index.md) included with the package.
+
+## Contributing
+
+Contributions are welcome! If you have suggestions for new utility functions, improvements to existing ones, or any other feedback, feel free to open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the [ISC License](LICENSE).

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26563

increased by0.03%

Number of lines in readme file

46

increased by253.85%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes