Docs & README
Quando uma alteração afeta a forma como alguém instala, executa, configura ou usa o projeto, atualize o README.md na mesma mudança.
O README deve cobrir, resumidamente:
- O que é o projeto (1-2 frases).
- Requisitos e passos de instalação.
- Como executar, testar e construir — comandos copiáveis.
- Configuração: cada variável de ambiente com sua finalidade e um valor de exemplo (nunca segredos reais).
- Exemplos curtos de uso para as funcionalidades principais.
Regras:
- Edite apenas as seções que a mudança afeta; não reescreva o arquivo inteiro.
- Verifique se cada comando que você documenta realmente funciona.
- Português, frases curtas, sem linguagem de marketing.