@fad-producto-portal/ng-fad-signature-fea 1.0.0-alpha.9 → 1.0.0

package/README.md

@@ -1,24 +1,62 @@
-# NgFadSignatureFea
+# @fad-producto-portal/ng-fad-signature-fea
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.2.0.
+## Introduction
 
-## Code scaffolding
+The `@fad-producto-portal/ng-fad-signature-fea` package provides a set of standalone Angular components designed to handle **digital signing flows** within the FAD Portal.
 
-Run `ng generate component component-name --project ng-fad-signature-fea` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ng-fad-signature-fea`.
-> Note: Don't forget to add `--project ng-fad-signature-fea` or else it will be added to the default project in your `angular.json` file. 
+These components are built to work independently or integrated with other FAD modules, offering high customization via configuration inputs and visual flexibility.  
+The module includes approval lists, PDF viewers, error handling, signature summaries, RFC validations, and electronic signature uploads.
 
-## Build
+## Prerequisites
 
-Run `ng build ng-fad-signature-fea` to build the project. The build artifacts will be stored in the `dist/` directory.
+Before installing this package, make sure you:
 
-## Publishing
+- Have a valid token to install private FAD modules.
+- Are using Angular 16 or higher configured in your workspace.
+- Have access to the private GitLab repository of FAD libraries.
 
-After building your library with `ng build ng-fad-signature-fea`, go to the dist folder `cd dist/ng-fad-signature-fea` and run `npm publish`.
+### Install peer-dependencies
 
-## Running unit tests
+```bash
+npm install timers@0.1.1 hls.js@1.5.18 @fad-producto-portal/ng-fad-services@^1.0.0
+```
 
-Run `ng test ng-fad-signature-fea` to execute the unit tests via [Karma](https://karma-runner.github.io).
+|Library                               |Version|
+|--------------------------------------|-------|
+|timers                                |0.1.1  |
+|hls.js                                |1.5.18 |
+|@fad-producto-portal/ng-fad-services  |1.x.x  |
 
-## Further help
+## Installation
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+Install the package with the following command:
+
+```bash
+npm install @fad-producto-portal/ng-fad-signature-fea
+```
+
+## Assets
+
+Add the following to your `angular.json` to include the necessary assets:
+
+```json
+{
+  "glob": "**/*",
+  "input": "node_modules/@fad-producto-portal/ng-fad-signature-fea/assets",
+  "output": "./assets/"
+}
+```
+
+## Additional Documentation
+
+To explore the full list of components, configurations, and usage examples:
+
+```bash
+code node_modules/@fad-producto-portal/ng-fad-signature-fea/USAGE_GUIDE.md
+```
+
+Or navigate to:
+
+```
+node_modules/@fad-producto-portal/ng-fad-signature-fea/USAGE_GUIDE.md
+```