@cyberskill/shared 1.30.0 → 1.32.0

package/README.md

@@ -1,48 +1,109 @@
-![](./src/public/favicon/favicon-96x96.png)
+<p align="center">
+  <img src="./src/public/favicon/favicon-96x96.png" width="96" height="96" alt="CyberSkill Logo">
+</p>
 
-# CyberSkill Shared
+<h1 align="center">🚀 CyberSkill Shared</h1>
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![JSDocs][jsdocs-src]][jsdocs-href]
-[![License][license-src]][license-href]
+<p align="center">
+  <b>A shared utility library for consistent development across CyberSkill projects.</b>
+</p>
 
-## License
+---
 
-[MIT](./LICENSE) License © [Stephen Cheng](https://github.com/zintaen)
+<p align="center">
+  <a href="https://npmjs.com/package/@cyberskill/shared">
+    <img src="https://img.shields.io/npm/v/@cyberskill/shared?style=for-the-badge&color=blue" alt="npm version">
+  </a>
+  <a href="https://npmjs.com/package/@cyberskill/shared">
+    <img src="https://img.shields.io/npm/dm/@cyberskill/shared?style=for-the-badge&color=brightgreen" alt="npm downloads">
+  </a>
+  <a href="https://www.jsdocs.io/package/@cyberskill/shared">
+    <img src="https://img.shields.io/badge/jsDocs.io-reference-blue?style=for-the-badge" alt="JSDocs">
+  </a>
+  <a href="https://github.com/cyberskill-world/shared/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue?style=for-the-badge" alt="License">
+  </a>
+</p>
 
-<!-- Badges -->
+---
 
-[npm-version-src]: https://img.shields.io/npm/v/@cyberskill/shared?style=flat&colorA=080f12&colorB=1fa669
-[npm-version-href]: https://npmjs.com/package/@cyberskill/shared
-[npm-downloads-src]: https://img.shields.io/npm/dm/@cyberskill/shared?style=flat&colorA=080f12&colorB=1fa669
-[npm-downloads-href]: https://npmjs.com/package/@cyberskill/shared
-[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
-[jsdocs-href]: https://www.jsdocs.io/package/@cyberskill/shared
-[license-src]: https://img.shields.io/github/license/cyberskill-world/shared.svg?style=flat&colorA=080f12&colorB=1fa669
-[license-href]: https://github.com/cyberskill-world/shared/blob/main/LICENSE
+## 🎯 **About**
 
-## Usage
+CyberSkill Shared is a modular utility library designed to:
+
+- 📦 **Provide reusable utility functions** across multiple projects.
+- ⚙️ **Ensure consistent coding standards**.
+- 🚀 **Boost developer productivity** by reducing repetitive code.
+
+---
+
+## 🚀 **Installation**
+
+Install via **npm**:
 
 ```bash
-# development
-npm run dev
+npm install @cyberskill/shared
+```
+
+Install via **yarn**:
+
+```bash
+yarn add @cyberskill/shared
+```
 
-# production
-npm run build
+---
 
-# lint check
-npm run lint
+## 🛠️ **Scripts**
 
-# lint fix
-npm run lint:fix
+| Command                | Description                         |
+| ---------------------- | ----------------------------------- |
+| `npm run dev`          | Start development mode 🚧           |
+| `npm run build`        | Build for production 🚀             |
+| `npm run lint`         | Check for linting issues ✅         |
+| `npm run lint:fix`     | Fix linting issues 🔧               |
+| `npm run lint:inspect` | Inspect linting config 🧐           |
+| `npm run setup`        | Project setup 🏗️                    |
+| `npm run reset`        | Reset the project ♻️                |
+| `npm run inspect`      | Inspect the project dependencies 🔍 |
 
-# lint inspect
-npm run lint:inspect
+---
 
-# project setup
-npm run setup
+## 📂 **Project Structure**
 
-# project reset
-npm run reset
+```plaintext
+src/
+├── components/     → Reusable UI components (buttons, modals, etc.)
+├── configs/        → App configuration files
+├── constants/      → Static values used across the app
+├── contexts/       → React context providers
+├── controllers/    → Business logic controllers
+├── hocs/           → Higher Order Components (HOCs)
+├── hooks/          → Custom hooks
+├── providers/      → State management and third-party providers
+├── public/         → Static assets (images, fonts, etc.)
+├── styles/         → Global and component-specific styles
+├── typescript/     → TypeScript types and interfaces
+├── utils/          → Utility functions and helpers
+├── commands.ts     → CLI commands and setup logic
+└── index.ts        → Entry point for the app
 ```
+
+---
+
+## 🎯 **Goals**
+
+- ✅ Consistent TypeScript support.
+- ✅ Minimize code duplication.
+- ✅ Easy to extend and maintain.
+
+---
+
+## 📄 **License**
+
+**[MIT](./LICENSE)** License © [Stephen Cheng](https://github.com/zintaen)
+
+---
+
+<p align="center">
+  Made with ❤️ by <a href="https://github.com/zintaen">@zintaen</a>
+</p>