plugin-ui-for-kzt 0.0.2 → 0.0.4

package/README.md

@@ -1,83 +1,119 @@
-# plugin-ui-kzt
+# plugin-ui-for-kzt
 
 A custom UI plugin for Vue 3 + TypeScript projects, with Quasar integration support.
 
 ---
 
-## Installation
+## 🚀 Installation
 
-### Prerequisites
-- Node.js version **23.x** or higher
+### ✅ Prerequisites
+
+- Node.js **v23.x** or higher
+- Vue 3 project (with or without Quasar)
+
+### 📦 Install the Plugin
 
-### Install the Plugin
 ```bash
 npm install plugin-ui-for-kzt
 ```
 
 ---
 
-## Quasar Project Setup
+## ⚙️ Quasar Integration Setup
+
+If you're using **Quasar**, follow these additional steps to properly integrate the plugin:
+
+### 1. Create a Boot File
+
+Create a new file named `plugin-ui-for-kzt.ts` in your project's `boot/` directory.
 
-If you are using **Quasar**, follow these additional steps:
+```ts
+// src/boot/plugin-ui-for-kzt.ts
+import { boot } from 'quasar/wrappers'
+import PluginUIForKZT from 'plugin-ui-for-kzt'
 
-1. **Create a Boot File:**
-    - Create a new file named `plugin-ui-for-kzt.ts` inside the `boot/` folder.
+export default boot(({ app }) => {
+  app.use(PluginUIForKZT)
+})
+```
+
+### 2. Register the Boot File in `quasar.config.js`
+
+```js
+boot: [
+  'plugin-ui-for-kzt',
+  // other boot files
+]
+```
 
-2. **Register the Boot File:**
-    - In `quasar.config.js`, add `'plugin-ui-for-kzt'` to the `boot` array:
-   ```js
-   boot: [
-     'plugin-ui-kzt',
-     // other boot files
-   ]
-   ```
+### 3. (Optional) Import in `client-entry.js` if needed
 
-3. **Import in `client-entry.js`:**
-    - Import your boot file inside the `Promise.all` method:
-   ```js
-   import('boot/plugin-ui-for-kzt')
-   ```
+```js
+import('boot/plugin-ui-for-kzt')
+```
 
 ---
 
-## Publishing the Plugin to npm
+## 🔢 Plugin Versioning Rules
 
-Follow these steps to update and publish the plugin:
+The plugin version must follow the pattern: `X.Y.Z`, with a **maximum version value of 100**.  
+Examples of valid versions:
 
-1. **Update the Version:**
-    - Before publishing, **update the `version`** field in `package.json` (according to semantic versioning).
+- `version: "0.0.25"`
+- `version: "0.25.99"`
+- `version: "46.25.46"`
 
-2. **Push Changes to GitLab:**
-    - Commit and push all your changes to your GitLab repository.
+---
 
-3. **Login to npm:**
-   ```bash
-   npm login
-   ```
-    - Use the **npm credentials** stored in GitLab.
+## 🚀 Publishing the Plugin to npm
 
-4. **Publish the Plugin:**
-   ```bash
-   npm publish --access public
-   ```
+Follow these steps to update and publish a new version of the plugin:
 
-5. **Clear Cache (Recommended):**
-   ```bash
-   npm cache clean --force
-   ```
+### 1. Update the Version
 
-6. **Update Plugin in Your Project:**
-   ```bash
-   npm install plugin-ui-for-kzt@latest --force
-   ```
+Update the `version` field in your `package.json` file according to [Semantic Versioning](https://semver.org/).
 
-7. **Clean and Run Your Quasar Project:**
-   ```bash
-   quasar clean
-   quasar dev
-   ```
+### 2. Commit and Push to GitLab
 
----
+```bash
+git add .
+git commit -m "chore: bump version to x.x.x"
+git push
+```
+
+### 3. Log in to npm
+
+```bash
+npm login
+```
 
-✅ Done! Now your updated plugin will be installed and ready to use!
+> 💡 Use the **npm credentials** stored in your GitLab vault or settings.
+
+### 4. Publish the Package
+
+```bash
+npm publish --access public
+```
+
+### 5. (Optional) Clear npm Cache
+
+```bash
+npm cache clean --force
+```
+
+### 6. Update the Plugin in Your Project
+
+```bash
+npm install plugin-ui-for-kzt@latest --force
+```
+
+### 7. Restart Your Quasar Project
+
+```bash
+quasar clean
+quasar dev
+```
+
+---
 
+✅ **Done!** Your plugin is now published and integrated successfully into your Quasar project.