@ng-simplicity/forms-core 1.1.1 → 1.1.3

package/README.md

@@ -1,16 +1,21 @@
 # @ng-simplicity/forms-core
 
+[![Documentation](https://img.shields.io/badge/Docs-ng--simplicity--forms.bryangwalsh.com-4f46e5.svg)](https://ng-simplicity-forms.bryangwalsh.com)
+
+📖 **Documentation, tutorials and live demos:** [ng-simplicity-forms.bryangwalsh.com](https://ng-simplicity-forms.bryangwalsh.com) · [Core concepts](https://ng-simplicity-forms.bryangwalsh.com/guides/core-concepts) · [API reference](https://ng-simplicity-forms.bryangwalsh.com/api)
+
 The core engine package for **NG-Simplicity Forms**. This package manages form states, dynamic registry injection, component lifecycle bindings, and structural layout directives (Rows, Columns, Sections, Groups, Arrays). It enables you to construct highly dynamic, complex forms where control properties (such as visibility, enabled/disabled state, select options, and validation rules) reactively adapt in real-time based on the current values inside the form. The engine is highly customizable, allowing you to develop and add your own custom form controls to the registry to be used in the form rendering.
 
 This core package is extended by styling integration packages that provide prebuilt themed form components:
 - **[@ng-simplicity/forms-bootstrap](../forms-bootstrap/README.md)**: Dynamic forms pre-styled with Bootstrap form fields and layouts.
 - **[@ng-simplicity/forms-material](../forms-material/README.md)**: Dynamic forms pre-styled with Angular Material inputs and controls.
+- **[@ng-simplicity/forms-tailwind](../forms-tailwind/README.md)**: Dynamic forms styled with Tailwind CSS utility classes, with every class overridable through `provideNgsFormsTailwindClasses()`.
 
 ## Compatibility
 
 | Package | Package version | Angular support |
 |---|---:|---|
-| `@ng-simplicity/forms-core` | `1.1.1` | `17.x`–`22.x` |
+| `@ng-simplicity/forms-core` | `1.1.3` | `17.x`–`22.x` |
 
 ---
 
@@ -22,6 +27,16 @@ Add this package to your Angular application:
 npm install @ng-simplicity/forms-core
 ```
 
+To render prebuilt inputs, add one styling package and register its components:
+
+| Styling | Install | Register |
+|---|---|---|
+| Bootstrap 5 | `npm install @ng-simplicity/forms-bootstrap bootstrap` | `NgsFormsBootstrapModule.registerAllBootStrapComponents(registry)` |
+| Angular Material | `npm install @ng-simplicity/forms-material` (after `ng add @angular/material`) | `NgsFormsMaterialModule.registerAllMaterialComponents(registry)` |
+| Tailwind CSS | `npm install @ng-simplicity/forms-tailwind`, then add `@source '../node_modules/@ng-simplicity/forms-tailwind';` to your Tailwind stylesheet | `NgsFormsTailwindModule.registerAllTailwindComponents(registry)` |
+
+Each `registerAll…` helper also registers the core structural components, so it is the only registration call you need. See each package's README for full setup.
+
 ---
 
 ## Architecture Overview
@@ -517,6 +532,7 @@ Ensure your custom configuration type extends one of these core interfaces for f
 Fully functional example applications demonstrating the form engine functionality are located in the [`apps/`](../../apps) folder of this monorepo:
 - **`forms-bootstrap-demo`**: Integrates and showcases the `@ng-simplicity/forms-bootstrap` package.
 - **`forms-material-demo`**: Integrates and showcases the `@ng-simplicity/forms-material` package.
+- **`forms-tailwind-demo`**: Integrates and showcases the `@ng-simplicity/forms-tailwind` package.
 
 ---