melhorias nas orientações de uso

.gitignore

@@ -1,3 +1,5 @@
 .env
 *.pyc
-docker-composer.yaml
+docker-composer.yaml
+GPT.postman_collection.json
+.venv/

readme.md

@@ -1,34 +1,64 @@
-## Transcrição e Resumo de Audios no Whatsapp usando python
+# Transcrição e Resumo de Áudios no WhatsApp usando Python
 
 ![ImpacteAI](./fluxo.png)
 
-### Setup Local
+Este projeto permite transcrever e resumir áudios enviados pelo WhatsApp usando inteligência artificial e integração com APIs. Ideal para automatizar o processamento de mensagens de áudio, oferecendo um resumo claro e prático.
+
+---
+
+## 📋 **Pré-requisitos**
+Antes de começar, certifique-se de ter os seguintes requisitos:
+- Python 3.10+ instalado ([Download](https://www.python.org/downloads/))
+- Docker e Docker Compose instalados ([Instruções](https://docs.docker.com/get-docker/))
+- Uma conta Evolution API com chave válida
+- Uma conta GROQ API com chave válida
+
+---
+
+## ⚙️ **Setup Local**
+
+### Ambiente Virtual
+Configure o ambiente virtual para instalar as dependências do projeto:
+
+#### **Linux ou macOS**
 ```bash
-# Linux ou Mac
 virtualenv venv
 source ./venv/bin/activate 
 pip install -r requirements.txt
-
+```
- # Windows
+#### **Windows**
+```bash
 python -m venv .venv
 source .venv/Scripts/activate
 pip install -r requirements.txt
 ```
-para sair do venv é deactivate
+Para sair do ambiente virtual, use:
-### Como Executar localmente
+```bash
-Rode o Comando
+deactivate
+```
+### 🚀 Como Executar Localmente
+Certifique-se de que todas as dependências foram instaladas.
+Rode o comando abaixo para iniciar o servidor:
 ```bash
 uvicorn main:app --host 0.0.0.0 --port 8005
 ```
-### Endpoint de uso para inserir na sua Evolution api como webhook
+Acesse o serviço localmente em: http://127.0.0.1:8005.
+
+### 🌐 Configuração de Webhook na Evolution API
+Endpoint para Webhook
+Use o seguinte endpoint para configurar seu webhook na Evolution API:
 ```bash
 https://transcricaoaudio.seudominio.com.br/transcreve-audios
 ```
-### Em caso de uso local
+### Testando Localmente
+Se estiver rodando localmente, use o comando curl para testar:
 ```bash
 curl --location 'http://127.0.0.1:8005/transcreve-audios'
 ```
-### Para instalar com Docker Swarm e Traefik use o .yaml abaixo como referencia
+### 🐳 Instalação com Docker Swarm e Traefik
+Se preferir rodar o projeto em um ambiente de produção com Docker Swarm e Traefik, use o arquivo de configuração abaixo como referência.
+
+docker-compose.yaml
 ```bash
 version: "3.7"
 
@@ -76,5 +106,19 @@ networks:
   suarededocker: #troque pela sua rede do docker
     external: true
     name: suarededocker #troque pela sua rede do docker
+```
+---
 
-```
+## 📖 **Configuração das Variáveis de Ambiente**
+Ao usar o Docker Compose, configure as seguintes variáveis de ambiente no arquivo `docker-compose.yaml`:
+
+| Variável               | Descrição                                                                                  |
+|------------------------|--------------------------------------------------------------------------------------------|
+| `WHATSAPP_API_KEY`     | Chave da API Evolution para integração com o WhatsApp.                                     |
+| `WHATSAPP_API_URL`     | URL da sua instância da Evolution API.                                                     |
+| `WHATSAPP_INSTANCE`    | Nome da instância configurada na Evolution API.                                            |
+| `GROQ_API_KEY`         | Chave da API GROQ para realizar transcrições e resumos de áudios.                          |
+| `BUSINESS_MESSAGE`     | Mensagem de divulgação que será adicionada ao final das transcrições.                      |
+| `PROCESS_GROUP_MESSAGES` | Define se mensagens enviadas em grupos devem ser processadas (`true`) ou ignoradas (`false`). |
+
+---