catarina 1.0.0 → 1.0.1

package/README.md

@@ -1,63 +1,185 @@
-# Catarina
+## Catarina – Design System para Angular
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
+**Catarina** es una librería de componentes UI para Angular 20.3.x.  
+Incluye botones, iconos, controles de formulario, paneles y utilidades relacionadas con _theming_ e iconos.
 
-## Code scaffolding
+La librería está publicada con el nombre:
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+- **Paquete npm**: `catarina`
+- **Versión**: `1.0.1`
 
-```bash
-ng generate component component-name
-```
+---
+
+## Requisitos
+
+`catarina` declara las siguientes _peerDependencies_:
+
+- `@angular/core`: `^20.3.0`
+- `@angular/common`: `^20.3.0`
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+Y depende de:
+
+- `tslib`: `^2.3.0`
+
+---
+
+## Instalación
+
+En un proyecto Angular 20:
 
 ```bash
-ng generate --help
+npm install catarina
 ```
 
-## Building
+También se puede instalar con `pnpm` o `yarn` usando el mismo nombre de paquete.
 
-To build the library, run:
+---
 
-```bash
-ng build catarina
+## API pública
+
+El archivo `public-api.ts` expone los principales elementos del design system:
+
+- **Componentes de diseño**:
+  - `Icon` (`cat-icon`)
+  - `Button` (`cat-button`)
+  - Paneles (`card`, `accordion`, `accordion-group`)
+- **Componentes de formulario**:
+  - `cat-input`, `color-input`, `select-input`, `date-input`, `file-input`,
+    `password-input`, `range-input`, `text-area-input`, `time-input`
+- **Overlays**:
+  - `dialog`
+- **Servicios y directivas**:
+  - Directiva de arrastre (`drag`)
+  - Utilidades de _theming_
+- **Tokens**:
+  - `ICON_PROVIDER`
+
+Todos estos símbolos se importan directamente desde el paquete `catarina`.
+
+---
+
+## Configuración de iconos con `safirial-icons`
+
+`catarina` utiliza el token `ICON_PROVIDER` para resolver las rutas de los iconos.  
+Este token se puede configurar usando las utilidades del paquete `safirial-icons`:
+
+```ts
+// app.config.ts
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { ICON_PROVIDER as CATARINA_ICON_PROVIDER } from 'catarina';
+import { getIconPath } from 'safirial-icons';
+
+const iconProviderConfig = {
+  getPath: getIconPath
+};
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideHttpClient(),
+    { provide: CATARINA_ICON_PROVIDER, useValue: iconProviderConfig }
+  ]
+};
+```
+
+Con esta configuración, los componentes de `catarina` que usan iconos resuelven las rutas desde `safirial-icons`.
+
+### Configuración de assets en `angular.json`
+
+Además de configurar el `ICON_PROVIDER`, es necesario añadir la siguiente entrada en la sección `assets` de `angular.json` para que los archivos SVG de `safirial-icons` se copien al directorio de salida:
+
+```json
+{
+  "projects": {
+    "tu-proyecto": {
+      "architect": {
+        "build": {
+          "options": {
+            "assets": [
+              "src/favicon.ico",
+              "src/assets",
+              {
+                "glob": "**/*.svg",
+                "input": "node_modules/safirial-icons/assets",
+                "output": "safirial-icons"
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+Esta configuración copia todos los archivos SVG desde `node_modules/safirial-icons/assets` a la carpeta `safirial-icons` en el directorio de salida de la aplicación.
 
-### Publishing the Library
+---
 
-Once the project is built, you can publish your library by following these steps:
+## Uso básico de componentes
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/catarina
-   ```
+Ejemplo de uso de `cat-button` e `Icon` dentro de un componente de aplicación:
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+```ts
+// app.component.ts
+import { Component } from '@angular/core';
+import { Button as CatarinaButton, Icon as CatarinaIcon } from 'catarina';
 
-## Running unit tests
+@Component({
+  selector: 'app-root',
+  imports: [CatarinaButton, CatarinaIcon],
+  template: `
+    <cat-button variant="primary" size="md" iconLeft="home">
+      Botón Catarina
+    </cat-button>
+
+    <cat-icon name="sun" [size]="'32px'"></cat-icon>
+  `
+})
+export class AppComponent {}
+```
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+Los valores de `name` de los iconos deben coincidir con los nombres definidos en `iconList` del paquete `safirial-icons`.
+
+---
+
+## Construcción y publicación
+
+Para compilar la librería desde el workspace:
 
 ```bash
-ng test
+ng build catarina
 ```
 
-## Running end-to-end tests
+El resultado se genera en:
 
-For end-to-end (e2e) testing, run:
+```bash
+dist/catarina
+```
+
+Para publicar en npm (desde el workspace):
 
 ```bash
-ng e2e
+ng build catarina
+cd dist/catarina
+npm publish
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+---
+
+## Idioma / Language
+
+Esta documentación está disponible en español. Para la versión en inglés, consulta [README.en.md](./README.en.md).
+
+This documentation is available in Spanish. For the English version, see [README.en.md](./README.en.md).
+
+---
+
+## Nota sobre la documentación
 
-## Additional Resources
+Esta documentación fue generada usando **Cursor** con los siguientes parámetros:
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+- **Herramienta**: Cursor IDE
+- **Modelo**: Auto (agente router de Cursor)
+- **Idioma**: Español
+- **Instrucciones**: Analizar todos los proyectos del workspace y actualizar la documentación para consumo, sin incluir errores, mejoras ni sugerencias, solo información factual sobre instalación, configuración y uso de las librerías.

package/package.json

@@ -1,6 +1,24 @@
 {
   "name": "catarina",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "description": "Angular 20.3.0 UI Design System, preview: https://jpcn-portfolio.vercel.app/catarina-preview",
+  "keywords": [
+    "angular",
+    "design-system",
+    "ui",
+    "components",
+    "hydenaky"
+  ],
+  "author": "hydenaky",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Hydenaky/library-workspace"
+  },
+  "bugs": {
+    "url": "https://github.com/Hydenaky/library-workspace/issues"
+  },
+  "homepage": "https://github.com/Hydenaky/library-workspace/blob/main/README.md",
   "peerDependencies": {
     "@angular/common": "^20.3.0",
     "@angular/core": "^20.3.0"