README Agent

Uma extensão de IDE que gera README para pastas usando IA

Uma extensão de IDE que gera README para pastas usando IA

O README Agent é uma poderosa ferramenta desenvolvida por Diego Fornalha que utiliza a API do Google Gemini para analisar projetos e gerar documentação detalhada automaticamente em português do Brasil.

🌟 Funcionalidades

• Geração Inteligente de READMEs: Analisa o conteúdo dos arquivos para criar documentação contextual e relevante
• Interface Simples: Basta clicar com o botão direito em uma pasta e selecionar "Regras Diego > Gerar README"
• Otimizado para Português: Gera documentação clara e bem estruturada em português do Brasil
• Detecção Inteligente de Código: Identifica linguagens de programação e frameworks para documentação apropriada
• Documentação Completa: Inclui detalhes de instalação, uso, requisitos e exemplos de código

📋 Como Usar

1. Instale a extensão README Agent
2. Clique com o botão direito em uma pasta no VS Code
3. Selecione "Regras Diego > Gerar README"
4. A extensão analisará automaticamente o código e gerará um README.md detalhado

🧠 Tecnologia

O README Agent utiliza o modelo Gemini do Google para:

• Analisar a estrutura de projetos
• Compreender o propósito do código
• Identificar dependências e requisitos
• Gerar documentação técnica precisa
• Criar exemplos de código contextuais

👨‍💻 Sobre o Autor

Diego Fornalha é um desenvolvedor e especialista em IA com experiência em criar ferramentas que aumentam a produtividade dos desenvolvedores. Ele desenvolveu o README Agent para resolver o problema comum de documentação inadequada em projetos, economizando tempo e garantindo que o código seja bem documentado.

📝 Requisitos

• Visual Studio Code 1.83.1 ou superior
• Conexão com internet para acessar a API do Gemini
• Chave API do Google Gemini (configurável através de arquivo .env)

🛠️ Personalização

A extensão pode ser personalizada para gerar documentação de acordo com suas necessidades específicas, alterando os prompts em src/prompts.ts.

📄 Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.

Desenvolvido com ❤️ por Diego Fornalha
GitHub | LinkedIn