From 381fb286759a5215c63a941c9c4b692e34b56698 Mon Sep 17 00:00:00 2001
From: Tudor Stanciu <tudor.stanciu94@gmail.com>
Date: Sun, 30 Mar 2025 02:56:09 +0200
Subject: [PATCH] Update README and package.json for improved descriptions and
 formatting

---
 README.md    | 76 +++++++++++++++++++++++++++++++++++++++-------------
 package.json |  2 +-
 2 files changed, 59 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index e5f9fbb..51e21d9 100644
--- a/README.md
+++ b/README.md
@@ -2,36 +2,76 @@
 
 ## Introduction
 
-utiliyo is a collection of utilities that facilitate software development in a javascript environment.
+**utiliyo** is a lightweight utility library designed to simplify common tasks in JavaScript development. It provides a set of well-structured and reusable functions that enhance productivity and code maintainability.
 
-## Package installation
+## Installation
+
+You can install **utiliyo** using either `npm` or `yarn` from my private registry:
 
 ```bash
-// with npm
-npm i --save @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
+# Using npm
+npm install --save @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
 
-// with yarn
+# Using yarn
 yarn add @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
 ```
 
-## How to use the package
+## Usage
 
-```jsx
+Import and use the utility functions in your project:
+
+```javascript
 import { typeValidator, localStorage, camelizeKeys } from "@flare/utiliyo";
 ```
 
-## Unit testing
+## Features
 
-Unit testing is done using [Jest](https://jestjs.io/). This is an awesome testing framework created by Facebook.  
-The files containing tests are identified by the extension `*.test.ts`.  
-All tests in the package can be executed by running: `npm test`.
+- **Type Validation** – Validate data types efficiently.
+- **Local Storage Utilities** – Simplify interactions with `localStorage`.
+- **Data Formatting** – Includes functions like `camelizeKeys` to transform object keys.
+
+## Unit Testing
+
+All utilities are rigorously tested using [Jest](https://jestjs.io/), a powerful testing framework developed by Facebook.
+
+- Test files follow the naming convention `*.test.ts`.
+- Run all tests with:
+
+```bash
+npm test
+```
 
 ## Changelog
 
-1.0.0 - This version includes data type validators and local storage utils  
-1.0.1 - Set new domain in configs  
-1.0.2 - Utility functions export fix  
-1.0.3 - Typescript warnings fix  
-1.0.4 - Added "camelizeKeys" function  
-1.1.0 - The package has been migrated to TypeScript. Unit tests using Jest have also been added.  
-1.2.0 - Rebrand package from js-utils to utiliyo.
+#### v1.2.0
+
+- Rebranded package from `js-utils` to `utiliyo`.
+
+#### v1.1.0
+
+- Migrated the package to TypeScript.
+- Added unit tests using Jest.
+
+#### v1.0.4
+
+- Introduced the `camelizeKeys` function.
+
+#### v1.0.3
+
+- Fixed TypeScript warnings.
+
+#### v1.0.2
+
+- Fixed issues with utility function exports.
+
+#### v1.0.1
+
+- Updated domain configurations.
+
+#### v1.0.0
+
+- Initial release with data type validators and local storage utilities.
+
+---
+
+For further details, contributions, or issue reporting, visit the [repository](https://lab.code-rove.com/gitea/bricks/utiliyo).
diff --git a/package.json b/package.json
index 6bd44d9..1450d25 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@flare/utiliyo",
   "version": "1.2.0",
-  "description": "utiliyo is a collection of utilities that facilitate software development in a javascript environment.",
+  "description": "utiliyo is a lightweight utility library designed to simplify common tasks in JavaScript development. It provides a set of well-structured and reusable functions that enhance productivity and code maintainability.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {