tecnualng 21.0.11 → 21.0.16

package/README.md

@@ -1,63 +1,200 @@
-# Tecnualng
+# TecnualNG
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.0.0.
+TecnualNG is a modern Angular UI component library designed to provide reusable, customizable, and well‑structured components for building professional web applications. It aims to accelerate development by offering consistent, accessible, and theme‑friendly UI elements that integrate seamlessly into any Angular project.
 
-## Code scaffolding
+---
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+## 🚀 Purpose of the Library
+
+TecnualNG was created to:
+
+- Offer a robust collection of reusable Angular components.
+- Standardize the visual and functional design of Angular applications.
+- Reduce development time by avoiding repetitive UI implementation.
+- Serve as a scalable base for internal and external Angular projects.
+- Provide a live demo application where all components can be previewed.
+
+---
+
+## 📦 Installation
+
+Install the library from **npm**:
 
 ```bash
-ng generate component component-name
+npm install tecnualng
 ```
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+Or with **pnpm**:
 
 ```bash
-ng generate --help
+pnpm add tecnualng
 ```
 
-## Building
+---
+
+## 🛠 Development Requirements
+
+To use TecnualNG:
+
+- **Node.js 20+**
+- **Angular 21+** (fully compatible with Angular 21)
+- **TypeScript 5+**
 
-To build the library, run:
+To contribute to the project:
+
+- Git
+- npm or pnpm
+- Angular CLI
+
+---
+
+## 🔧 Getting Started in Your Angular Project
+
+### 1. Install the library
 
 ```bash
-ng build tecnualng
+pnpm add tecnualng
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+### 2. Import a component
 
-### Publishing the Library
+Each component can be imported individually to keep your bundle small.
 
-Once the project is built, you can publish your library by following these steps:
+```ts
+import { TnButtonComponent } from 'tecnualng';
+```
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/tecnualng
-   ```
+### 3. Use it in a template
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+```html
+<tn-button label="Accept" (click)="onClick()"></tn-button>
+```
+
+### 4. Apply styling or theming
+
+TecnualNG supports flexible styling with theme‑ready architecture.
+
+---
+
+## 📁 Project Structure
+
+The repository consists of the library source code and a demo application used for showcasing the components.
+
+```
+tecnualng/
+│
+├── projects/
+│   ├── tecnualng/        → Main library source code
+│   └── demo/             → Demo Angular application
+│
+├── dist/                 → Build output
+├── angular.json          → Angular workspace configuration
+├── package.json
+└── README.md
+```
+
+### 📦 Library (`projects/tecnualng`)
+
+- Components
+- Modules
+- Services
+- Styles and configuration
+
+### 🎨 Demo (`projects/demo`)
+
+- Component examples
+- Navigation and layout
+- Real usage scenarios
+
+---
+
+## 🧪 Running the Project in Development Mode
 
-## Running unit tests
+Install dependencies:
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+```bash
+pnpm install
+```
+
+Build the library in watch mode:
+
+```bash
+ng build tecnualng --watch
+```
+
+Run the demo application:
 
 ```bash
-ng test
+ng serve demo
+```
+
+Open in the browser:
+
 ```
+http://localhost:4200/
+```
+
+---
 
-## Running end-to-end tests
+## 🚀 Publishing the Library
 
-For end-to-end (e2e) testing, run:
+To publish manually:
 
 ```bash
-ng e2e
+npm publish dist/tecnualng
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+This repository includes GitHub Actions workflows for:
+
+- Publishing automatically to **npm** when a version tag is pushed
+- Generating an automatic **changelog**
+- Deploying the demo application to **GitHub Pages**
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a feature branch using Git Flow:
+   ```bash
+   git flow feature start feature-name
+   ```
+3. Follow **Conventional Commits**:
+
+   - `feat:` new features
+   - `fix:` bug fixes
+   - `docs:` documentation updates
+   - `refactor:` internal improvements
+   - `chore:` maintenance tasks
+
+4. Add tests where applicable.
+5. Open a Pull Request to the **develop** branch.
+
+### 📝 Contribution Guidelines
+
+- Follow Angular best practices.
+- Use strict TypeScript typing.
+- Avoid unnecessary dependencies.
+- Validate your changes in the demo application before submitting a PR.
+
+---
+
+## 📄 License
+
+TecnualNG is released under the **Hippocratic License** — free for personal and commercial projects.
+
+---
+
+## 🌐 Online Demo
+
+A hosted demo will be available on GitHub Pages:
+
+```
+https://tecnual.github.io/tecnualng/
+```
 
-## Additional Resources
+---
 
-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.
+If you’d like to include advanced examples, screenshots, a full component list, or FAQs, let me know and I’ll expand the README.