@maropost-ui/liquidsky-ui 0.0.9 → 0.0.11

package/README.md

@@ -1,5 +1,5 @@
-# @liquidsky/ui
-# 0.0.8
+# @maropost-ui/liquidsky-ui
+
 A shared UI component library, composables, and utilities for Vue 3 + Vuetify applications. This package provides reusable components and common functionality to accelerate development across multiple frontend applications.
 
 
@@ -26,18 +26,23 @@ The following packages are required as peer dependencies:
 - `date-fns-tz` (^3.2.0) - Date utilities with timezone support
 - `lz-string` (^1.5.0) - String compression library
 
+------------------------------------------------------------------------
+
 
 ## Quick Start
 
 ```bash
-npm install @liquidsky/ui
+npm install @maropost-ui/liquidsky-ui
 ```
 ```typescript
-import { AppBreadcrumb } from '@liquidsky/ui'
+import { AppBreadcrumb } from '@maropost-ui/liquidsky-ui'
 ```
 
-## @liquidsky/ui Local Development Guide
-Use these methods to test @liquidsky/ui changes in your consuming project (e.g., commerce-frontend or commerce-backoffice) without publishing to npm. Both leverage npm's linking and packaging features for rapid iteration in your app workflow.
+------------------------------------------------------------------------
+
+
+## @maropost-ui/liquidsky-ui Local Development Guide
+Use these methods to test @maropost-ui/liquidsky-ui changes in your consuming project (e.g., commerce-frontend or commerce-backoffice) without publishing to npm. Both leverage npm's linking and packaging features for rapid iteration in your app workflow.
 
 
 
@@ -69,7 +74,7 @@ Creates a symlink for instant hot-reloading of changes.
 4. **In your consuming project (e.g., `commerce-frontend`):**
    ```bash
    cd /path/to/your/consuming-project
-   npm link @liquidsky/ui
+   npm link @maropost-ui/liquidsky-ui
    ```
 
 Now, any changes you make in the `liquidsky-frontend` package will be reflected in your consuming project after rebuilding the library. This is useful for rapid development and testing across multiple projects locally.
@@ -97,6 +102,65 @@ cd /path/to/commerce-backoffice  # or your project
 npm install ../../path/to/liquidsky-frontend/liquidsky-ui-<version>.tgz
 ```
 
+------------------------------------------------------------------------
+
+
+## Updating and Publishing Liquidsky Package with npm
+
+### ✅ 1. Commit changes including version update
+
+Before publishing, make sure everything is committed and pushed to your
+`main` branch.
+
+-   Update your code
+-   Then update the version in `package.json`
+
+You can do it manually or run:
+
+``` bash
+npm version patch --no-git-tag-version   # bug fixes
+npm version minor --no-git-tag-version   # new features
+npm version major --no-git-tag-version   # breaking changes
+```
+- Then run `npm run changelog:generate` to generate `changelog.md` file
+
+Commit and push everything:
+
+``` bash
+git add .
+git commit -m "feat: update package (vX.X.X)"
+git push origin main
+```
+
+
+### ✅ 2. Login to npm
+
+If not already logged in:
+
+``` bash
+npm login
+```
+
+### ✅ 3. Publish your package
+
+Run:
+
+``` bash
+npm publish
+```
+
+For scoped packages:
+
+``` bash
+npm publish --access public
+```
+
+
+✅ That's it --- your changes are now live.
+
+------------------------------------------------------------------------
+
+
 ## Documentation
 
 This package features automated Storybook documentation that stays synchronized with your components and keeps docs always up-to-date with your code.