@ng-zen/cli 19.1.0-next.1 → 19.2.0-next.1

package/.github/workflows/deploy.yml

@@ -2,7 +2,8 @@ name: Deploy Storybook to github pages
 
 on:
   push:
-    branches: ["master"]
+    tags:
+      - 'v*.*.*'
   workflow_dispatch:
 
 env:
@@ -18,14 +19,21 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4 # Checkout your repository
-      - uses: pnpm/action-setup@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Enable Corepack
+        run: corepack enable
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
         with:
           version: ${{ env.PNPM_VERSION }}
-      - uses: actions/setup-node@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
-      - id: build-publish
+          cache: 'pnpm'
+      - name: Build and deploy Storybook
+        id: build-publish
         uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3
         with:
           install_command: pnpm install --frozen-lockfile

package/.github/workflows/release.yml

@@ -20,6 +20,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
+          persist-credentials: false
           fetch-depth: 0
           fetch-tags: true
       - name: Enable Corepack

package/.storybook/stories/pages/{1 Welcome.mdx → 1 README.mdx }

@@ -4,6 +4,6 @@ import { Markdown } from '@storybook/blocks';
 
 import { Meta } from '@storybook/blocks';
 
-<Meta title="Welcome" />
+<Meta title="README" />
 
 <Markdown>{ReadMe}</Markdown>

package/.storybook/stories/pages/2 License.mdx

@@ -4,6 +4,6 @@ import { Markdown } from '@storybook/blocks';
 
 import { Meta } from '@storybook/blocks';
 
-<Meta title="License - BSD-2-Clause" />
+<Meta title="LICENSE - BSD-2-Clause" />
 
 <Markdown>{License}</Markdown>

package/.storybook/stories/pages/3 CHANGELOG.mdx

@@ -0,0 +1,9 @@
+import CHANGELOG from '../../../CHANGELOG.md?raw';
+
+import { Markdown } from '@storybook/blocks';
+
+import { Meta } from '@storybook/blocks';
+
+<Meta title="CHANGELOG" />
+
+<Markdown>{CHANGELOG}</Markdown>

package/CHANGELOG.md

@@ -1,3 +1,45 @@
+## 19.2.0-next.1 (2025-05-23)
+
+* chore(dependencies): update dependencies (#187) ([7028a9e](https://github.com/kstepien3/ng-zen/commit/7028a9e)), closes [#187](https://github.com/kstepien3/ng-zen/issues/187)
+* chore(dependencies): update ngx-schematic-builder to v0.2.0 (#183) ([5ea0cea](https://github.com/kstepien3/ng-zen/commit/5ea0cea)), closes [#183](https://github.com/kstepien3/ng-zen/issues/183)
+* chore(workflow): update deploy workflow for tag-based triggering (#166) ([0fea522](https://github.com/kstepien3/ng-zen/commit/0fea522)), closes [#166](https://github.com/kstepien3/ng-zen/issues/166) [#165](https://github.com/kstepien3/ng-zen/issues/165)
+* chore(workflows): disable persist-credentials in release workflow (#188) ([b784e47](https://github.com/kstepien3/ng-zen/commit/b784e47)), closes [#188](https://github.com/kstepien3/ng-zen/issues/188)
+* feat(divider): add zen-divider component (#186) ([c021773](https://github.com/kstepien3/ng-zen/commit/c021773)), closes [#186](https://github.com/kstepien3/ng-zen/issues/186)
+* style(components): update outline styles (#184) ([5737a15](https://github.com/kstepien3/ng-zen/commit/5737a15)), closes [#184](https://github.com/kstepien3/ng-zen/issues/184)
+* fix(schematics/ng-add): run other schematics after installation (#177) ([5cb1be4](https://github.com/kstepien3/ng-zen/commit/5cb1be4)), closes [#177](https://github.com/kstepien3/ng-zen/issues/177)
+* ci(eslint): fix plugins and configure linting rules (#176) ([5e93a09](https://github.com/kstepien3/ng-zen/commit/5e93a09)), closes [#176](https://github.com/kstepien3/ng-zen/issues/176)
+* build(deps-dev): bump typescript from 5.7.3 to 5.8.3 (#154) ([3ebe49f](https://github.com/kstepien3/ng-zen/commit/3ebe49f)), closes [#154](https://github.com/kstepien3/ng-zen/issues/154)
+* build(ngx-schematic-builder): migrate the custom builder (#175) ([c7d19eb](https://github.com/kstepien3/ng-zen/commit/c7d19eb)), closes [#175](https://github.com/kstepien3/ng-zen/issues/175)
+* Merge remote-tracking branch 'origin/next' into develop ([f581d01](https://github.com/kstepien3/ng-zen/commit/f581d01))
+
+## [19.1.0](https://github.com/kstepien3/ng-zen/compare/v19.0.0...v19.1.0) (2025-04-27)
+
+### 🚀 New Features
+
+* **switch:** add missing css variables ([0481ac7](https://github.com/kstepien3/ng-zen/commit/0481ac7d735eba4ee47fbc6a69cdee643f5b9b4c))
+
+### 🏗️ Build Changes
+
+* **deps-dev:** bump @angular-devkit/architect from 0.1902.6 to 0.1902.9 ([#160](https://github.com/kstepien3/ng-zen/issues/160)) ([e8fa092](https://github.com/kstepien3/ng-zen/commit/e8fa092e8aefcd15f4fb5755e150b2834d359fb4))
+* **deps-dev:** bump angular-eslint from 19.0.2 to 19.3.0 ([#136](https://github.com/kstepien3/ng-zen/issues/136)) ([ccad1a9](https://github.com/kstepien3/ng-zen/commit/ccad1a903bbd8edf37571f764dded81ea5fe29aa))
+* **deps-dev:** bump eslint-plugin-storybook from 0.11.6 to 0.12.0 ([#137](https://github.com/kstepien3/ng-zen/issues/137)) ([e8d63f3](https://github.com/kstepien3/ng-zen/commit/e8d63f3ec9d7f0af1a4cb7e2ceb3ff2843af43ad))
+* **deps-dev:** bump typescript-eslint from 8.24.0 to 8.29.0 ([#135](https://github.com/kstepien3/ng-zen/issues/135)) ([89d371f](https://github.com/kstepien3/ng-zen/commit/89d371f73f711848c548c32e8c1d5201f80c3073))
+
+### 🧹 Chore
+
+* add conventional-changelog-conventionalcommits dependency ([c6d2342](https://github.com/kstepien3/ng-zen/commit/c6d23422c5866645b520f55dc3c10700fc268d06))
+* change version alpha -> next ([aa5482c](https://github.com/kstepien3/ng-zen/commit/aa5482cd504a89e60eae07f6a3ea343ca8886e57))
+* change version to v19.0.0-next.0 [skip ci] ([7ee3dbd](https://github.com/kstepien3/ng-zen/commit/7ee3dbd6d22a3d24c85fba0978c127f28c9248d4))
+* fix problems with release ([a54af7a](https://github.com/kstepien3/ng-zen/commit/a54af7aa33259bb904df707f8450b39a1f8e00c9))
+* **release:** 19.1.0-next.1 [skip ci] ([7ca3b5c](https://github.com/kstepien3/ng-zen/commit/7ca3b5c989121b41c95c261236b5c89409c83210))
+
+### 📚 Documentation
+
+* **readme.md:** update links in badges ([#146](https://github.com/kstepien3/ng-zen/issues/146)) ([667f71c](https://github.com/kstepien3/ng-zen/commit/667f71c3891764f12d7b025e4b0c7e9ea872d00b))
+* **README:** improve documentation ([#149](https://github.com/kstepien3/ng-zen/issues/149)) ([bbbfd4e](https://github.com/kstepien3/ng-zen/commit/bbbfd4e592907c6c544e9004d104842df5475fab))
+* **storybook:** load CHANGELOG.md ([#145](https://github.com/kstepien3/ng-zen/issues/145)) ([f7df739](https://github.com/kstepien3/ng-zen/commit/f7df739ba88d4ffc1a63dea6bdec2bb3112933d0))
+* update development information ([#148](https://github.com/kstepien3/ng-zen/issues/148)) ([981a998](https://github.com/kstepien3/ng-zen/commit/981a9981385d22d763fe63bfcf075970bec4495d))
+
 ## [19.1.0-next.1](https://github.com/kstepien3/ng-zen/compare/v19.0.0...v19.1.0-next.1) (2025-04-06)
 
 ### 🚀 New Features

package/CONTRIBUTING.md

@@ -1,27 +1,54 @@
 # Contributing to @ng-zen/cli
 
-Thank you for considering contributing to **@ng-zen/cli**! This project is maintained by Konrad Stępień and is open to contributions from the community.
-
-## How to Contribute
-
-1. **Fork the Repository**: Create a fork of the [ng-zen repository](https://github.com/Kordrad/ng-zen) on GitHub.
-2. **Create a Feature Branch**: Create a new branch for your feature or bug fix. Use a descriptive name for the branch, such as `feature/new-component` or `fix/documentation`.
-3. **Make Your Changes**: Implement your feature or fix. Ensure that your code adheres to the project's coding standards and best practices.
-4. **Write Tests**: If applicable, add unit tests or integration tests to cover your changes.
-5. **Submit a Pull Request**: Push your changes to your fork and submit a pull request to the main repository. Include a detailed description of your changes.
-
-## Contribution Guidelines
-
-- **Code Quality**: Ensure that your code is well-formatted, readable, and follows Angular best practices.
-- **Documentation**: Update documentation if necessary. Use JSDoc for code comments and ensure that Storybook examples are updated.
-- **Testing**: Include tests for new functionality or bug fixes.
-- **Commit Messages**: Use meaningful commit messages that follow the conventional commit format.
+Thank you for your interest in contributing! This document outlines the essential steps and requirements for submitting contributions.
+
+**For detailed information on project setup, the full branching strategy, specific tool usage (Storybook, Verdaccio), and the reasoning behind our workflows, please refer to the [DEVELOPMENT.md](DEVELOPMENT.md) file.**
+
+## Key Requirements for Contributors
+
+1.  **Conventional Commits (Mandatory):** All commit messages **must** adhere to the Conventional Commits specification (https://www.conventionalcommits.org/). This is critical for automated releases. Invalid messages will block commits. See [Commit Messages](DEVELOPMENT.md#commit-messages-crucial) for details on commit types and their impact.
+2.  **Target Branch:** Pull Requests **must target the `develop` branch.** PRs targeting `master` or `next` directly will generally be closed unless specifically requested for hotfixes.
+3.  **Automated Checks:**
+
+- Code formatting and basic lint fixes are applied automatically on commit via `husky` and `nano-staged`.
+- Full CI checks (linting, testing, building) run automatically on Pull Requests via GitHub Actions (`ci.yml`). **Your PR must pass all CI checks to be eligible for merging.**
+
+## Contribution Steps
+
+1.  **Fork & Clone:** Fork the [ng-zen repository](https://github.com/kstepien3/ng-zen) and clone your fork locally. _(See [Prerequisites & Setup](DEVELOPMENT.md#prerequisites--setup) if needed)_.
+2.  **Sync `develop`:** Ensure your local `develop` branch is up-to-date:
+    ```bash
+    git switch develop
+    git pull origin develop
+    ```
+3.  **Create Branch:** Create your working branch **from `develop`**:
+    ```bash
+    # Use format: <type>/<short-description>
+    git switch -c feat/add-hover-effect develop
+    ```
+4.  **Develop:** Implement your code changes. Remember to add or update relevant unit tests (`*.spec.ts`) and documentation/Storybook stories (`*.stories.ts`, etc.) as necessary. _(See [Working with Storybook](DEVELOPMENT.md#working-with-storybook) section for more details)_.
+5.  **Commit:** Commit your work using **Conventional Commit** messages.
+    ```bash
+    git add .
+    git commit -m "feat(button): add configurable hover effect"
+    ```
+6.  **Verify Locally:** Before pushing, ensure all local checks pass:
+    ```bash
+    pnpm run lint
+    pnpm run test
+    ```
+    _(See [Running Tests and Linting](DEVELOPMENT.md#running-tests-and-linting) for details on these commands)_.
+7.  **Push:** Push your branch to your fork: `git push origin feat/add-hover-effect`
+8.  **Create Pull Request:** Open a Pull Request on GitHub from **your branch** to the **`kstepien3/ng-zen:develop`** branch. Provide a clear title and description.
+
+## After Your PR is Submitted
+
+- Wait for the automated CI checks to complete. Address any failures.
+- Respond to code review comments and feedback from maintainers.
+- Once approved and CI passes, a maintainer will merge your PR into `develop`. Your changes will then be included in future pre-releases (from `next`) and stable releases (from `master`).
 
 ## Communication
 
-- **Issues**: If you encounter any issues or have questions, feel free to open an issue on GitHub.
-- **Pull Request Reviews**: Be prepared to address feedback from maintainers during the review process.
-
-## Acknowledgments
+- Use [GitHub Issues](https://github.com/kstepien3/ng-zen/issues) for bug reports, feature proposals, or questions _before_ starting significant work.
 
-Your contributions are invaluable to the growth and success of **@ng-zen/cli**. Thank you for your time and effort!
+Thank you for contributing to **@ng-zen/cli**

package/DEVELOPMENT.md

@@ -1,80 +1,138 @@
 # Local Development Setup
 
-This guide will help you set up a local development environment for **@ng-zen/cli**.
+This guide details setting up a local development environment for **@ng-zen/cli**. It covers the necessary tools, the project's branching strategy, and the automated workflows in place.
 
-## Prerequisites
+**For a step-by-step guide specifically for external contributors submitting Pull Requests, please refer to `CONTRIBUTING.md`.**
 
-- Node.js (preferably the latest LTS version)
-- pnpm
-- Angular CLI installed globally
-- verdaccio
+**Key Technologies & Concepts:**
 
-## Working with Storybook
+- **pnpm:** The required package manager (version in `package.json`). Use Corepack (`corepack enable`).
+- **Storybook:** For UI component development and visualization.
+- **Conventional Commits:** **Mandatory format** for commit messages (https://www.conventionalcommits.org/). Crucial for automation.
+- **Automated Formatting/Linting:** `husky` + `nano-staged` apply formatting and basic fixes on commit.
+- **Automated CI:** GitHub Actions (`ci.yml`) validate Pull Requests.
+- **Automated Releases:** `semantic-release` manages releases based on commits.
+- **Branching Strategy:** Detailed below.
 
-**Storybook** is the primary tool for developing and testing UI components. To start Storybook, run:
+## Table of Contents
 
-```bash
-pnpm run storybook
-```
+- [Prerequisites & Setup](#prerequisites--setup)
+- [Branching Strategy & Workflow](#branching-strategy--workflow)
+- [Commit Messages (Crucial!)](#commit-messages-crucial)
+- [Branch Synchronization (Maintainer Task)](#branch-synchronization-maintainer-task)
+- [Working with Storybook](#working-with-storybook)
+- [Running Tests and Linting](#running-tests-and-linting)
+- [Building the Library](#building-the-library)
+- [Optional: Local Testing with Verdaccio](#optional-local-testing-with-verdaccio)
+
+## Prerequisites & Setup
+
+1.  Ensure **Node.js** is installed (use a version compatible with the project's Angular version; check CI workflows for reference).
+2.  Enable **Corepack**: `corepack enable`.
+3.  Clone the repository.
+4.  Install dependencies using **pnpm**: `pnpm install`.
+
+## Branching Strategy & Workflow
+
+This project employs a branching model designed for stability and automated releases:
+
+- **`master`**: Contains only **stable, production-ready** code. Receives merges only from `next` during official releases or for critical hotfixes. Automated stable releases (`vX.Y.Z`) are triggered from here. **Direct work is forbidden.**
+- **`next`**: The **pre-release / release candidate** branch. Code merged here from `develop` should be stable enough for final testing. Merges trigger automated pre-releases (`vX.Y.Z-next.N`) published to NPM under the `next` dist-tag.
+- **`develop`**: The main **integration branch**. All feature branches are merged here first. This branch collects changes intended for the _next_ release cycle. **Target Pull Requests here.**
+- **Feature/Fix Branches (`feature/*`, `fix/*`, etc.)**: Used for individual tasks. Always branch **off `develop`**.
 
-This command will launch Storybook in your default browser, allowing you to interact with and test the components visually.
+**General Flow:** `Feature/Fix Branch` -> **`develop`** -> `next` -> `master`
 
-### Building Storybook
+## Commit Messages (Crucial!)
 
-To build a static version of Storybook for deployment, testing or release, use:
+Strict adherence to the **Conventional Commits** specification (https://www.conventionalcommits.org/) is **required**.
+
+- **Why?** Commit messages directly control automatic version bumping (`semantic-release`) and `CHANGELOG.md` generation.
+- **Format:** `<type>(<scope>): <subject>` (e.g., `feat(button): add loading spinner`).
+- **Key Types & Impact (on Stable Release):**
+- `feat`: New feature -> `minor` version bump.
+- `fix`: Bug fix -> `patch` version bump.
+- `!` (e.g., `refactor(core)!:`) or `BREAKING CHANGE:` footer -> `major` version bump.
+- Other types (`docs`, `chore`, `style`, `test`, `ci`, `build`, `refactor`, `perf`) document changes but don't trigger version bumps alone.
+- **Validation:** `husky` + `commitlint` automatically check message format upon commit. Invalid messages will fail the commit.
+
+_(See `CONTRIBUTING.md` for a concise summary focused on the commit action itself)._
+
+## Branch Synchronization (Maintainer Task)
+
+Maintain consistency across `master`, `next`, and `develop` by merging release commits and hotfixes. **Performed by maintainers.**
+
+**General Update Step:** Fetch latest remote state:
 
 ```bash
-pnpm run storybook:build
+git fetch origin --prune
 ```
 
-## Setting Up Verdaccio
+### 1. Sync `next` with `master` (After Stable Release or Hotfix)
+
+This is the most comprehensive synchronization, ensuring all development branches are aligned with the latest production code.
+
+- **Purpose:** Incorporate stable changes into the release candidate branch.
+- **Flow:** `master` -> `next`.
 
-1. **Install Verdaccio**:
-   Follow the instructions on the [Verdaccio website](https://verdaccio.org/docs/installation#installing-the-cli) to install Verdaccio.
+  ```bash
+  # Update local 'next', merge 'origin/master', push 'next'
+  git switch next && git pull origin next && git merge origin/master && git push origin next
+  ```
+
+  _(Note: Merge conflicts might occur at either merge step and need manual resolution before continuing/pushing.)_
+
+### 2. Sync `develop` with `next` (After Pre-release on next OR after syncing next with master)
 
-2. **Start Local Registry**:
-   Run the following command to start the local registry:
+- **Purpose:** Keep `develop` aligned with the latest pre-release state or the latest stable code propagated through next. Includes release commits (`chore(release): ...`).
+- **Flow:** `next` -> `develop`.
 
-   ```bash
-   pnpm run verdaccio
-   ```
+  ```bash
+  # Update local 'next', merge 'origin/master', push 'next'
+  git switch develop && git pull origin develop && git merge origin/next && git push origin develop
+  ```
 
-3. **Configure npm to Use Local Registry**:
-   Follow the prompts from Verdaccio to configure npm to use the local registry.
+  _(Note: Resolve conflicts before pushing.)_
 
-## Publishing Locally
+---
 
-1. **Publish Package Locally**:
-   Use the following command to publish the package to your local registry:
-   ```bash
-   pnpm run publish:local
-   ```
-2. **Test in Angular Project**:
-   Add the package to an Angular project using the local registry:
-   ```bash
-   ng add @ng-zen/cli --registry http://localhost:4873/
-   ```
+Contributors should regularly update their local `develop` branch (`git switch develop && git pull origin develop`).
 
-## Running Tests
+## Working with Storybook
 
-- **Unit Tests**: Run unit tests using the command:
+Develop and visualize components using Storybook.
+
+- **Start Storybook:**
   ```bash
-  pnpm run test
+  pnpm run storybook
   ```
-- **Linting**: Check code style and fix issues with:
+- **Build Static Storybook:**
   ```bash
-  pnpm run lint
-  pnpm run lint:fix
+  pnpm run storybook:build
   ```
 
-## Building and Packaging
+## Running Tests and Linting
+
+`nano-staged` auto-formats/fixes on commit, but manual verification is recommended before creating a PR. The CI (`ci.yml`) runs these checks automatically on PRs.
+
+- **Lint:** `pnpm run lint` (checks for errors not auto-fixed)
+- **Test:** `pnpm run test` (runs unit tests)
+
+## Building the Library
 
-**Build** the project using:
+Build the distributable library files:
 
 ```bash
 pnpm run build
 ```
 
----
+Output artifacts are placed in the `dist/` directory
+
+## Optional: Local Testing with Verdaccio
+
+Test your local build in a separate project before submitting a PR to develop.
 
-By following these steps, you should be able to set up a fully functional local development environment for **@ng-zen/cli**.
+1. Install & Run Verdaccio: `npm install -g verdaccio` (or `pnpm add -g`), then `verdaccio`.\
+2. Build Library: `pnpm run build`.
+3. Publish Locally: `pnpm run publish:verdaccio`.
+4. Install in Test Project: `ng add @ng-zen/cli --registry http://localhost:4873/` (or pnpm add ...).

package/README.md

@@ -1,21 +1,24 @@
 # @ng-zen/cli
 
-Angular library that helps you build better applications faster 🚀 Built with modern best practices and full customization in mind 💡
-
-[![Build Status](https://img.shields.io/github/actions/workflow/status/kstepien3/ng-zen/ci.yml?branch=master)](https://github.com/kstepien3/ng-zen)
-[![License](https://img.shields.io/badge/License-BSD--2--Clause-f5c076)](https://github.com/kstepien3/ng-zen/blob/master/LICENSE)
-[![Version](https://img.shields.io/npm/v/@ng-zen/cli)](https://www.npmjs.com/package/@ng-zen/cli)
+[![Build Status (master)](https://img.shields.io/github/actions/workflow/status/kstepien3/ng-zen/ci.yml?branch=master&label=build-master)](https://github.com/kstepien3/ng-zen/actions/workflows/ci.yml)
+[![Build Status (next)](https://img.shields.io/github/actions/workflow/status/kstepien3/ng-zen/ci.yml?branch=next&label=build-next)](https://github.com/kstepien3/ng-zen/actions/workflows/ci.yml)
+[![NPM Version (latest)](https://img.shields.io/npm/v/@ng-zen/cli/latest?label=npm%40latest)](https://www.npmjs.com/package/@ng-zen/cli)
+[![NPM Version (next)](https://img.shields.io/npm/v/@ng-zen/cli/next?label=npm%40next)](https://www.npmjs.com/package/@ng-zen/cli)
+[![License](https://img.shields.io/github/license/kstepien3/ng-zen)](https://github.com/kstepien3/ng-zen/blob/master/LICENSE)
 
 [![](https://img.shields.io/badge/-Repository-181818?style=flat&logo=github&logoColor=white)](https://github.com/kstepien3/ng-zen)
-[![](https://img.shields.io/badge/-NPM-CB3837?style=flat&logo=npm&logoColor=white)](https://github.com/kstepien3/ng-zen)
-[![](https://img.shields.io/badge/-Storybook-FF4785?style=flat&logo=storybook&logoColor=white)](https://www.npmjs.com/package/@ng-zen/cli)
+[![](https://img.shields.io/badge/-Storybook%20Demo-FF4785?style=flat&logo=storybook&logoColor=white)](https://kstepien3.github.io/ng-zen/)
+
+Generate modern, customizable Angular UI components and elements directly into your project 🚀
+
+Built with the best practices and developer experience in mind 💡
 
 ## Table of Contents
 
 1. [Features](#features)
 2. [Ideal for](#ideal-for)
 3. [Quick Start](#quick-start)
-4. [Installation](#Installation)
+4. [Installation](#installation)
 5. [Usage](#usage)
 6. [Why @ng-zen/cli?](#why-ng-zencli)
 7. [Examples](#examples)
@@ -24,46 +27,60 @@ Angular library that helps you build better applications faster 🚀 Built with
 10. [Contributing](#contributing)
 11. [License](#license)
 12. [Author](#author)
-13. [FAQ](#faq)
+13. [See also](#see-also)
+14. [FAQ](#faq)
 
 ## Features
 
-- 🧩 **Component Library** — Beautifully designed, rigorously tested UI components
-- 🎨 **Fully Customizable** — Easy to modify components with both SCSS and CSS variables
-- 📱 **Responsive Design** — Components work seamlessly across all device sizes
-- 📚 **Comprehensive Documentation** — Includes Storybook integration and detailed JSDoc
-- ✅ **Test Coverage** — All components include unit tests
-- 🚀 **Modern Angular** — Uses standalone components, OnPush change detection, signals, and other Angular best practices
+- 🧩 **Component Schematics:** Generates ready-to-use UI component code (`.ts`, `.html`, `.scss`).
+- 🎨 **Fully Customizable:** Easily theme and modify components via CSS variables and editable SCSS.
+- 📱 **Responsive Design:** Components designed to adapt across various screen sizes.
+- 📚 **Comprehensive Documentation:** Includes Storybook examples, JSDoc annotations, and `README.md` per component.
+- ✅ **Test Coverage:** Generated components include unit tests (`.spec.ts`).
+- 🚀 **Modern Angular:** Leverages standalone components, `OnPush` change detection, signals, and current best practices.
+- 🛠 **Extensible:** Planned support for generating directives, pipes, services, and more.
 
 ## Ideal for
 
-- 🏢 **Large Enterprises** — Perfect for companies planning to create their own UI kits, ensuring consistency across all projects.
-- 📈 **Individual Projects** — Suitable for projects requiring custom components, allowing developers to focus on unique features.
-- 👩‍💻 **Developers** — Accelerates application development by providing ready-to-use UI tools and speeding up the design process.
+- 🏢 **Enterprise UI Kits:** A great starting point for building consistent, internal component libraries.
+- 📈 **Custom Projects:** Accelerates development when custom UI elements are needed, avoiding vendor lock-in.
+- 👩‍💻 **Developers:** Speeds up UI creation and ensures adherence to modern Angular patterns.
 
 ## Quick Start
 
-### Installation
+The easiest way to add `@ng-zen/cli` and its schematics to your project:
 
 ```bash
 ng add @ng-zen/cli
 ```
 
-This command will install the package and set up the necessary configurations in your Angular project 📦.
+This command installs the package and performs initial setup.
+
+## Installation
+
+Alternatively, you can install it manually:
+
+```bash
+# For the latest stable version
+pnpm add -D @ng-zen/cli
+
+# For the latest pre-release version (includes newest features/fixes)
+pnpm add -D @ng-zen/cli@next
+```
 
 ## Usage
 
 ### Generating Components
 
-Use the Angular CLI to generate components:
+Use the Angular CLI schematic:
 
 ```bash
 ng generate @ng-zen/cli:component
 ```
 
-This interactive command will guide you through selecting and configuring components for your project 📊.
+This interactive prompt guides you through selecting and configuring the desired component(s) 📊.
 
-For more information use
+To see available options without running interactively:
 
 ```bash
 ng generate @ng-zen/cli:component --help
@@ -71,55 +88,54 @@ ng generate @ng-zen/cli:component --help
 
 ### Future Generators
 
-The library will soon include support for generating:
+Support for generating other Angular building blocks is planned:
 
 - 📝 Directives
-- 📊 Pipes
+- 💧 Pipes
 - 🛠 Services
-- And more...
+- ... and more!
 
 ## Why @ng-zen/cli?
 
-Unlike other UI libraries, @ng-zen/cli:
+Unlike pre-compiled UI libraries, `@ng-zen/cli`:
 
-- Generates actual code in your project that you can edit and customize 📝
-- Follows modern Angular best practices (_standalone components, OnPush, Signals, etc._) 🚀
-- Provides comprehensive documentation and testing support 📚
-- Makes customization straightforward with well-organized style variables 🎨
-- Focuses on developer experience and maintainability 💻
+- **Generates Source Code:** You get actual, editable component code in your project, not opaque `<library-button>` tags.
+- **Full Control:** Modify the generated code and styles freely to perfectly match your application's needs.
+- **Modern Foundation:** Built on current Angular features (standalone, signals, etc.).
+- **Transparency:** Understand exactly how components work and evolve them with your project.
+- **Developer Experience:** Focuses on ease of use, customization, and maintainability.
 
 ## Examples
 
-Each generated code comes with:
+Each generated component set includes:
 
 - Angular component code (`.ts`, `.html`, `.scss`)
 - Unit tests (`.spec.ts`)
-- Storybook stories (`.stories.ts`)
-- Export files via `index.ts`
-- Detailed documentation 📚
+- Storybook stories (`.stories.ts`) for visual development and documentation.
+- An `index.ts` for easy exporting.
+- A component-specific `README.md` (generated from a template).
 
 ## Documentation
 
-Components are documented using:
-
-- Comprehensive JSDoc annotations 📝
-- README file
-- Storybook integration for visual examples 📊
-- Compodoc for full API documentation 📚
+- **Storybook:** The primary source for visual examples and interactive demos: [View Storybook Demo](https://kstepien3.github.io/ng-zen/)
+- **JSDoc:** Code includes documentation comments.
+- **READMEs:** Project-level (`README.md`, `DEVELOPMENT.md`, `CONTRIBUTING.md`) and component-level READMEs.
+- **Changelog:** Automatically generated history of changes: [CHANGELOG.md](https://github.com/kstepien3/ng-zen/blob/master/CHANGELOG.md)
 
 ## Project Status
 
-🚧 **Under Development** 🚧
+🚧 **Actively Developed** 🚧
 
-This project is actively maintained and new features are being added regularly.
-Plans include support for generating directives, pipes, and services.
+- The core schematics and existing components are functional but continuously improved.
+- New generators (directives, pipes, etc.) are planned.
+- The `master` branch represents the latest **stable** release.
+- The `next` branch contains **pre-release** versions with the newest features and fixes – use `@ng-zen/cli@next` to try them out.
 
-You don't have to worry about the code, because you can use and edit the code as you want.
-Just the code I have created is still being developed with new functionalities.
+Since the tool generates code directly into your project, you own and control that code. Updates to `@ng-zen/cli` itself primarily bring new generator features or improvements to the generation process, not breaking changes to already generated components.
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request 🤝.
+Contributions are highly welcome! If you'd like to help improve `@ng-zen/cli`, please read our **[Contribution Guidelines (CONTRIBUTING.md)](https://github.com/kstepien3/ng-zen/blob/master/CONTRIBUTING.md)** for details on the workflow, commit message requirements, and setup. 🤝
 
 ## License
 
@@ -127,13 +143,18 @@ This project is licensed under the [BSD 2-Clause License](https://github.com/kst
 
 ## Author
 
-The Project is maintained by Konrad Stępień. Reach me here:
+Maintained by Konrad Stępień.
 
-- Email: [kord.stp@gmail.com](mailto:kord.stp@gmail.com?subject=%5BNG-ZEN%5D%20Hello%21) 📨
+- GitHub: [@kstepien3](https://github.com/kstepien3)
 - LinkedIn: [Konrad Stępień](https://www.linkedin.com/in/konradstepien/) 👥
+- Email: [kord.stp@gmail.com](mailto:kord.stp@gmail.com?subject=%5BNG-ZEN%5D%20Query) 📨
+
+## See also
+
+- [ngx-schematic-builder](https://github.com/kstepien3/ngx-schematic-builder) - A custom Angular builder for compiling and bundling Angular schematics.
 
 ## FAQ
 
 ### How do I customize a generated component?
 
-All generated components are fully editable and include SCSS/CSS variables for easy customization.
+Generated components reside entirely within your project's source code. You can directly edit the `.ts`, `.html`, and `.scss` files. Components are structured to use CSS variables and SCSS for easier theming and modification.

package/angular.json

@@ -20,9 +20,9 @@
       "prefix": "zen",
       "architect": {
         "build": {
-          "builder": "./projects/schematic-builder:build",
+          "builder": "ngx-schematic-builder:build",
           "options": {
-            "files": ["src/**", "README.md", "package.json", "LICENSE"],
+            "files": ["src/**", "README.md", "LICENSE", "CHANGELOG.md"],
             "tsConfig": "tsconfig.schematics.json"
           }
         },