@aslam-dev/my-lib 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,141 @@
+# 📦 @aslam-dev/my-lib
+
+Reusable **utility functions and React components** designed to accelerate frontend development with consistent formatting, validation, and UI helpers.
+
+---
+
+## 🚀 Installation
+
+```bash
+npm install @aslam-dev/my-lib
+```
+
+## Features
+
+- 🧰 Utility Functions
+
+  - 📅 Date & time helpers
+  - 📞 Phone number formatting and validation
+  - 🔄 Data transformation helpers
+
+- 🎨 React Components
+  - 🖼️ Image components with lazy loading and placeholders
+  - 📊 Chart components for data visualization
+  - 🧩 Form components with built-in validation
+
+## 📚 Usage
+
+### 📅 Date Utilities
+
+```javascript
+import { getCurrentDate } from "@aslam-dev/my-lib";
+
+const date = getCurrentDate();
+```
+
+### 📞 Phone Utilities
+
+```javascript
+import { formatPhoneNumber, validatePhoneNumber } from "@aslam-dev/my-lib";
+
+formatPhoneNumber("9876543210", "IN");
+validatePhoneNumber("9876543210", "IN");
+```
+
+### 🔄 Transformers
+
+```javascript
+import { groupByProperty } from "@aslam-dev/my-lib";
+
+const grouped = groupByProperty(products, "category");
+```
+
+### 📝 Note Component
+
+```javascript
+import { Note } from "@aslam-dev/my-lib";
+
+<Note title="Important" content="This is a reusable note component." />;
+```
+
+### 📜 BigNote Component
+
+```javascript
+import { BigNote } from "@aslam-dev/my-lib";
+
+<BigNote title="Large Content Viewer" />;
+```
+
+### 🧱 Library Structure
+
+src/
+├── components/
+│ ├── Note
+│ └── BigNote
+├── datetime
+├── phone
+├── transformers
+└── index.ts
+
+## 🎯 Design Goals
+
+## Reusability
+
+Encapsulates commonly used UI and utility logic.
+
+## Performance
+
+BigNote uses lazy chunk loading to avoid heavy DOM rendering.
+
+## Type Safety
+
+Fully written in TypeScript with exported type definitions.
+
+## Lightweight
+
+Minimal dependencies and optimized bundle output.
+
+## 🛠️ Development
+
+### Build Library
+
+```bash
+npm run build
+```
+
+### Local Testing
+
+```bash
+npm pack
+```
+
+Then install the generated tarball inside another project.
+
+### 📦 Package Exports
+
+Consumers should import from the root:
+
+```javascript
+import { Note, getCurrentDate } from "@aslam-dev/my-lib";
+```
+
+### 🔧 Peer Dependencies
+
+This library expects:
+
+```javascript
+react >= 18;
+```
+
+## 🗺️ Roadmap
+
+- Add more UI primitives
+- Expand transformer utilities
+- Add unit tests
+- Add Storybook documentation
+- Improve accessibility support
+
+## 👨‍💻 Author
+
+Aslam Mohammed
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-Aslam%20Mohammed-blue?logo=linkedin&style=for-the-badge)](https://www.linkedin.com/in/malaslam97/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aslam-dev/my-lib",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Reusable utility + UI helper library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",