@rubeusteam/rb-angular-components 0.0.1 → 0.0.2-dev.2

package/README.md

@@ -1,184 +1,119 @@
 # RbAngularComponents
 
-**PT-BR**  
-O `rb-angular-components` é uma biblioteca de componentes Angular reutilizáveis criada para acelerar o desenvolvimento de aplicações com base no Angular Material.
+Este projeto foi gerado usando o [Angular CLI](https://github.com/angular/angular-cli) versão 19.1.8.
 
-**EN**  
-`rb-angular-components` is a reusable Angular component library designed to speed up application development using Angular Material.
+This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.1.8.  
 
----
-
-## Instalação | Installation
-
-**PT-BR**  
-Para instalar a biblioteca em seu projeto Angular, execute:
-
-```bash
-npm install rb-angular-components
-```
+## Visão Geral | Overview 
 
-**EN**  
-To install the library in your Angular project, run:
+RbAngularComponents é uma biblioteca de componentes, diretivas, serviços e pipes Angular criada para acelerar o desenvolvimento de interfaces com consistência e boas práticas.
 
-```bash
-npm install rb-angular-components
-```
+RbAngularComponents is a library of Angular components, directives, services, and pipes designed to accelerate UI development with consistency and best practices.  
 
----
+## Requisitos
 
-## Uso Básico | Basic Usage
+- Angular >= 15 (suporta componentes standalone)  
+- Node.js >= 18.x  
+- npm >= 9.x  
+- Angular Material (alguns componentes são baseados nele)
 
-**PT-BR**  
-Importe os módulos desejados no seu `AppModule` ou no módulo onde deseja usar os componentes:
+## Requirements
 
-```ts
-import { RbCrudModule } from 'rb-angular-components';
-```
+- Angular >= 15 (supports standalone components)  
+- Node.js >= 18.x  
+- npm >= 9.x  
+- Angular Material (some components are based on it)  
 
-**EN**  
-Import the desired modules into your `AppModule` or the module where you want to use the components:
-
-```ts
-import { RbCrudModule } from 'rb-angular-components';
-```
-
----
-
-## Componentes Disponíveis | Available Components
-
-**PT-BR**  
-- `RbCrudComponent`: Componente de CRUD genérico com filtros, tabela e paginação.  
-- `RbFilterComponent`: Barra de pesquisa/filtros integrável ao CRUD.  
-- `RbContentCardComponent`: Quadro de conteúdo estilizado.  
-- E mais...
-
-**EN**  
-- `RbCrudComponent`: Generic CRUD component with filters, table, and pagination.  
-- `RbFilterComponent`: Search/filter bar that integrates with the CRUD.  
-- `RbContentCardComponent`: Styled content card.  
-- And more...
-
-Para detalhes específicos de uso, veja os READMEs individuais:  
-**To learn more about each, see the individual READMEs:**
-
-- [`docs/components/rb-crud`](./projects/rb-angular-components/src/lib/rb-crud/README.md)  
-- [`docs/components/rb-filter`](./projects/rb-angular-components/src/lib/rb-filter/README.md)
-
----
+## Instalação | Installation
 
-## Gerando Componentes | Code Scaffolding
+Instale a biblioteca via npm:
 
-**PT-BR**  
-Use o Angular CLI para gerar novos componentes, diretivas ou pipes:
+Install the library via npm:  
 
 ```bash
-ng generate component component-name
+npm install rb-angular-components
 ```
 
-**EN**  
-Use Angular CLI to generate new components, directives, or pipes:
+## Uso em Componentes Standalone | Usage in Standalone Components
 
-```bash
-ng generate component component-name
-```
+Você pode importar qualquer componente, diretiva ou pipe diretamente em seu componente standalone.
 
-Para ver todos os esquemas disponíveis:  
-**To list all available schematics:**
+You can import any component, directive, or pipe directly into your standalone component.  
 
-```bash
-ng generate --help
+```ts
+import { RbCrudComponent } from 'rb-angular-components';
+
+@Component({
+  standalone: true,
+  imports: [RbCrudComponent],
+  selector: 'app-demo',
+  template: '<rb-crud></rb-crud>'
+})
+export class DemoComponent {}
 ```
 
----
+## Uso em Módulos Angular (NgModules) | Usage in Angular Modules (NgModules) 
 
-## Build da Biblioteca | Building the Library
+Se seu projeto usa NgModules, ainda assim você pode usar os componentes standalone importando-os no array `imports`.
 
-**PT-BR**  
-Para construir a biblioteca, execute:
+If your project uses NgModules, you can still use the standalone components by importing them in the `imports` array.  
 
-```bash
-ng build rb-angular-components
-```
-
-**EN**  
-To build the library, run:
-
-```bash
-ng build rb-angular-components
+```ts
+import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { RbCrudComponent } from 'rb-angular-components';
+
+@NgModule({
+  imports: [
+    CommonModule,
+    RbCrudComponent // standalone component
+  ]
+})
+export class MyModule {}
 ```
 
-Os arquivos compilados serão gerados em `dist/`.  
-**The compiled files will be placed in `dist/`.**
-
----
+> Opcionalmente, você pode criar um módulo compartilhado que agrupe e exporte todos os componentes standalone para conveniência.
 
-### Publicação no NPM | Publishing to NPM
-
-**PT-BR**  
-1. Navegue até a pasta da biblioteca:
-   ```bash
-   cd dist/rb-angular-components
-   ```
-2. Publique com:
-   ```bash
-   npm publish
-   ```
-
-**EN**  
-1. Navigate to the library folder:
-   ```bash
-   cd dist/rb-angular-components
-   ```
-2. Publish using:
-   ```bash
-   npm publish
-   ```
+> Optionally, you can create a shared module that groups and exports all standalone components for convenience.  
 
----
 
-## Testes Unitários | Running Unit Tests
+## Recursos Disponíveis
 
-**PT-BR**  
-Para rodar os testes unitários com o Karma:
+- Componentes (ex: `RbCrudComponent`, `RbFilterComponent`)  
+- Diretivas (ex: `RbDynamicButtonDirective`)  
+- Pipes (ex: `RbCustomPipe`)  
+- Serviços (ex: `ClientFilterService`)  
+- Traduções (ex: `PaginatorPtbrIntlService`)
 
-```bash
-ng test
-```
+## Available Resources
 
-**EN**  
-To run unit tests with Karma:
+- Components (e.g., `RbCrudComponent`, `RbFilterComponent`)  
+- Directives (e.g., `RbDynamicButtonDirective`)  
+- Pipes (e.g., `RbCustomPipe`)  
+- Services (e.g., `ClientFilterService`)  
+- Translations (e.g., `PaginatorPtbrIntlService`)
 
-```bash
-ng test
-```
 
----
+## Documentação por Recurso | Documentation by Feature 
 
-## Testes de Integração (e2e) | Running End-to-End Tests
+Você pode acessar a documentação de cada recurso em sua respectiva pasta:
 
-**PT-BR**  
-Para rodar testes end-to-end:
+You can access documentation for each feature in its respective folder:  
 
-```bash
-ng e2e
-```
-
-**EN**  
-To run end-to-end tests:
-
-```bash
-ng e2e
-```
+- [`components/rb-content-box`](./src/lib/components/rb-content-box/README.md)  
+- [`components/rb-crud`](./src/lib/components/rb-crud/README.md)  
+- [`components/rb-filter`](./src/lib/components/rb-filter/README.md)  
+- [`components/rb-dialog`](./src/lib/components/rb-dialog/README.md)  
+- [`directives/rb-dynamic-button`](./src/lib/directives/rb-dynamic-button/README.md)  
+- [`pipes/rb-custom`](./src/lib/pipes/rb-custom/README.md)  
+- [`services/client-filter`](./src/lib/services/client-filter/README.md)  
+- [`i18n/paginator-ptbr-intl`](./src/lib/i18n/paginator-ptbr-intl/README.md)
 
 ---
 
-## Recursos Adicionais | Additional Resources
+## Recursos Adicionais | Additional Resources 
 
-**PT-BR**  
-Para mais informações sobre o Angular CLI, acesse:  
-[Angular CLI Overview and Command Reference](https://angular.dev/tools/cli)
+Para uso do Angular CLI e comandos, veja a [Referência do Angular CLI](https://angular.dev/tools/cli).
 
-**EN**  
-For more information on Angular CLI, visit:  
-[Angular CLI Overview and Command Reference](https://angular.dev/tools/cli)
+For Angular CLI usage and commands, see the [Angular CLI Reference](https://angular.dev/tools/cli).