@zidsa/zidmui 1.4.38 → 1.4.39

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,40 +1,42 @@
-## Installation
+<!-- markdownlint-disable-next-line -->
+<p align="center">
+  <a href="https://zid.sa/en/" rel="noopener" target="_blank"><img width="200" src="https://firebasestorage.googleapis.com/v0/b/standards-site-beta.appspot.com/o/documents%2Fd2n52d1l8uy%2F72b4eea4275%2F%5BZid%5D%20Logo_EN_1733924236833_2500x2500.png?alt=media&token=3387b769f69" alt="Zid logo"></a>
+</p>
+
+<h1 align="center">Zid MUI</h1>
+
+<div align="center">
 
-This project uses pnpm as package manager, It's imperative to use pnpm to keep package lock consistent. Please make sure to install it first https://pnpm.io/installation.
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zidsa/zidmui/blob/HEAD/LICENSE)
+[![npm latest package](https://img.shields.io/npm/v/@zidsa/zidmui/latest.svg)](https://www.npmjs.com/package/@zidsa/zidmui)
+[![npm downloads](https://img.shields.io/npm/dm/@zidsa/zidmui.svg)](https://www.npmjs.com/package/@zidsa/zidmui)
+
+</div>
+
+[Zid MUI](https://kit.zid.sa) is a React component library built on the [Parcel](https://brand.zid.sa) design system, adhering to [Zid's brand guidelines](https://brand.zid.sa). It provides shared components, icons, hooks, and theme utilities for building consistent UIs across Zid products.
+
+## Installation
 
 ```sh
 pnpm add @zidsa/zidmui
 ```
 
-Install https://taskfile.dev/installation/ to run project tasks
+## Documentation
 
-```bash
-$ task install
-```
+Get started in the [Zid MUI documentation](https://kit.zid.sa).
 
-## Running the app
+## Questions
 
-```bash
-# run build
-$ task build
+For how-to questions and bug reports, please use [GitHub Issues](https://github.com/zidsa/zidmui/issues).
 
-# list all available tasks
-$ task
-```
+## Contributing
 
-## Test
+Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.
 
-```bash
-# unit tests
-$ task test
-```
+## Changelog
 
-## Lint
+The [changelog](https://github.com/zidsa/zidmui/releases) is regularly updated to reflect what's changed in each new release.
 
-```bash
-# lint and fix any issues
-$ task lint
+## License
 
-# lint and and report any issues without fixing them
-$ task lint-check
-```
+This project is licensed under the terms of the [MIT license](/LICENSE).

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@zidsa/zidmui",
   "type": "module",
-  "version": "1.4.38",
+  "version": "1.4.39",
   "description": "Zid MUI shared components and utilities",
   "author": "Abdulaziz Homaily <a.homaily@gmail.com>",
   "license": "MIT",
+  "keywords": [
+    "react",
+    "react-component",
+    "mui",
+    "material-ui",
+    "material design",
+    "zid"
+  ],
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"