From bcec33656ac4a922047342eceb6aaec3bc08915c Mon Sep 17 00:00:00 2001
From: deMGoncalves <cleber.engineer@hotmail.com>
Date: Tue, 13 Aug 2024 22:32:47 -0300
Subject: [PATCH] docs: documenta o modulo echo

---
 package.json       |  2 +-
 src/echo/README.md | 68 ++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 63 insertions(+), 7 deletions(-)

diff --git a/package.json b/package.json
index 0c7d92f..9de4b92 100644
--- a/package.json
+++ b/package.json
@@ -53,5 +53,5 @@
   },
   "type": "module",
   "types": "types.d.ts",
-  "version": "0.0.7"
+  "version": "0.0.8"
 }
diff --git a/src/echo/README.md b/src/echo/README.md
index 2442484..53a54e4 100644
--- a/src/echo/README.md
+++ b/src/echo/README.md
@@ -1,17 +1,73 @@
-### Echo
+# Módulo Echo do **-O-id**
 
-# Echo module
+> **Em fase beta**: O módulo Echo está em fase beta, o que significa que pode haver alterações na API e no comportamento antes da versão final. Fique atento às atualizações para garantir a compatibilidade.
 
-O módulo Echo facilita a comunicação entre componentes através de um Event Bus, permitindo que eventos sejam transmitidos e recebidos por múltiplos componentes de maneira eficiente.
+## Nota Importante
+
+O módulo Echo do **-O-id** está atualmente em fase beta e deve ser considerado experimental. Ele serve como um barramento de eventos, facilitando a comunicação entre componentes de maneira eficiente. Use-o com cautela e esteja ciente de que o comportamento pode mudar em versões futuras.
+
+## Introdução
+
+O módulo Echo do **-O-id** oferece uma solução poderosa para gerenciar eventos entre Web Components. Ele permite que você defina e escute eventos entre componentes de maneira fácil e eficiente. A seguir, apresentamos como utilizar o Echo para criar um sistema de eventos interconectados.
 
 ## Importação
 
-Para importar o módulo Echo, utilize:
+Para utilizar o módulo Echo, importe-o da seguinte forma:
+
+```javascript
+import Echo from '@bake-js/-o-id/echo';
+```
+
+## Estrutura do Atributo `on`
+
+O atributo `on` do módulo Echo segue a estrutura "topic:mapper". A estrutura é detalhada a seguir:
+
+- **Topic:** Define o tópico do evento e é composto por "element/event".
+- **Mapper:** Especifica o destino e o nome do alvo dentro do evento. O mapper é composto por "target/target-name", onde os alvos podem ser:
+  - **attribute**: Referência a atributos do componente.
+  - **setter**: Referência a métodos setter do componente.
+  - **method**: Referência a métodos do componente.
+
+### Exemplos de Uso
+
+#### Definindo um Componente com Echo
 
 ```javascript
+import { define } from '@bake-js/element';
 import Echo from '@bake-js/element/echo';
+
+@define('sender-component')
+class SenderComponent extends Echo(HTMLElement) {
+
+}
+
+@define('receiver-component')
+class ReceiverComponent extends Echo(HTMLElement) {
+
+}
+```
+
+#### Comunicação entre Componentes no HTML
+
+```html
+<sender-component></sender-component>
+<receiver-component on="sender-component/messageSent:method/handleMessage"></receiver-component>
 ```
 
-## Índice
+No exemplo acima:
+- O `SenderComponent` emite um evento personalizado `messageSent` quando o botão é clicado.
+- O `ReceiverComponent` escuta esse evento e atualiza seu conteúdo com a mensagem recebida.
+
+## Por Que Usar o Decorator `@on`
+
+Utilizar o decorator `@on` oferece várias vantagens:
+
+- **Simplicidade e Clareza:** Reduz a verbosidade do código, tornando a associação de eventos mais clara e direta.
+- **Reusabilidade:** Permite o uso de múltiplos decorators no mesmo método, simplificando a configuração e evitando a necessidade de chamar métodos manualmente.
+- **Eficiência:** Facilita a escrita e manutenção do código, pois o decorator gerencia automaticamente a associação e desassociação de eventos.
+
+Adotar o decorator `@on` proporciona uma abordagem mais limpa e organizada para gerenciar eventos em seus Web Components, resultando em uma implementação mais eficiente e menos propensa a erros.
+
+## Conclusão
 
-- [Echo](https://github.com/bake-js/element/blob/main/src/echo/README.md)
+O módulo Echo oferece uma maneira eficiente de gerenciar e propagar eventos entre Web Components. Utilizando o atributo `on`, você pode facilmente conectar eventos emitidos por um componente a métodos em outro componente, simplificando a comunicação e integração entre diferentes partes de sua aplicação.