readme4meREADME
O que o projeto faz, como rodar e como está organizado, em markdown para colar direto no repositório.
- Instalação e scripts
- Estrutura do projeto
- Prévia ao vivo
README · Diagrama ER · Arquitetura
Documente qualquer repositório em minutos
O readme4me lê o seu repositório do GitHub e escreve o README, o diagrama entidade-relacionamento e a arquitetura de alto nível. Prontos para editar, versionar e exportar.
Acesso somente leitura · Seu código nunca treina modelos de IA
README.mdER diagramHigh-level design
1title Acme shop2direction right34Apps [color: blue] {5 Web [icon: react]6 API [icon: nodejs]7}89Data [color: purple] {10 MongoDB [icon: mongodb]11 Redis [icon: redis]12}1314Web > API: REST15API > MongoDB: queries16API --> Redis: cache17API > Stripe: billing
Três documentos que todo repositório precisa
Escolha um repositório e o readme4me descobre quais documentos consegue escrever. Cada um é gerado a partir do próprio código, não de um modelo pronto.
Diagrama entidade-relacionamento
Tabelas, campos e relacionamentos lidos do seu schema e dos seus models, desenhados num diagrama que você pode reorganizar.
- Chaves e cardinalidade
- Prisma, Drizzle, SQL e mais
- Exportação em SVG e PNG
Arquitetura de alto nível
Os serviços, bancos de dados e integrações por trás do app, agrupados e conectados do jeito que as requisições realmente fluem.
- Mais de 2.000 ícones de tecnologia
- Fluxo das requisições
- Código editável
Do repositório à documentação em quatro passos
- 1
Conecte o GitHub
Instale o GitHub App do readme4me com acesso somente leitura e escolha exatamente quais repositórios ele pode ler.
- 2
Analise o repositório
Uma análise gratuita, sem IA, verifica os arquivos e mostra quais documentos o repositório comporta.
- 3
Gere
A busca inteligente escolhe os arquivos de que o documento precisa e a IA o escreve em cerca de um minuto. Você paga em créditos de IA.
- 4
Edite, versione, exporte
Ajuste o código ao lado de uma prévia ao vivo, salve versões, copie o markdown ou exporte os diagramas em SVG e PNG.
Feito para o código que importa para você
O readme4me só precisa ler. Veja exatamente o que ele faz com o seu repositório.
Acesso somente leitura
O GitHub App pede apenas permissões de leitura, nos repositórios que você escolher.
Nada é escrito no seu repositório
Nenhum commit, nenhum pull request, nenhuma issue. O seu repositório continua exatamente como está.
Não é usado para treinar IA
Os arquivos são enviados aos modelos de IA que usamos para escrever o documento. Eles não são usados para treinar modelos.
Token do GitHub criptografado
O token que permite ao readme4me ler os seus repositórios é guardado criptografado.
Apague tudo quando quiser
Uma ação na sua conta remove seus repositórios, documentos, a conexão com o GitHub e o plano.
Pagamentos pelo Stripe
Os dados do cartão vão direto para o Stripe. O readme4me nunca os vê nem os guarda.
Pague pelo que o readme4me escreve
Todo plano concede o próprio preço em créditos de IA a cada mês. A análise é grátis; os créditos só são gastos quando um documento é gerado.
Starter
$9/ mês
90 créditos de IA por mês
For a few projects that deserve real documentation.
- README, database and architecture diagrams for about 5 repositories a month
- Private and public repositories, you pick which ones
- Live editor for Markdown and diagrams, SVG and PNG export
- Full version history
Pro
Mais escolhido$19/ mês
190 créditos de IA por mês
For developers keeping several services documented as they ship.
- README, database and architecture diagrams for about 12 repositories a month
- Room to regenerate after every release
- Everything in Starter
Max
$39/ mês
390 créditos de IA por mês
For tech leads and consultants documenting every repository they touch.
- README, database and architecture diagrams for about 25 repositories a month
- Room to keep every repository up to date
- Everything in Pro
1 crédito de IA = US$ 0,10 de uso de IA. Preços em dólares americanos.
Dúvidas
O que o readme4me escreve?
Um README em markdown, um diagrama entidade-relacionamento (ERD) e um diagrama de arquitetura de alto nível (HLD). Uma análise gratuita mostra quais deles cada repositório comporta.
O readme4me altera o meu repositório?
Não. Ele só tem acesso de leitura. Nunca faz commits, abre pull requests nem cria issues.
Meu código é usado para treinar modelos de IA?
Não. Os arquivos de que um documento precisa são enviados ao provedor de IA que usamos para escrevê-lo, e não são usados para treinar modelos. A Política de Privacidade explica como o seu código é tratado.
Quais repositórios ele pode ler?
Apenas os que você selecionar ao instalar o GitHub App, incluindo repositórios privados. Você pode mudar a seleção no GitHub a qualquer momento.
Como funcionam os créditos de IA?
Gerar um documento usa créditos de IA; 1 crédito equivale a US$ 0,10 de uso de IA. Cada plano concede o próprio preço em créditos todo mês, então um plano de US$ 19 dá 190 créditos. A análise não custa nada.
Posso editar o que o readme4me escreve?
Sim. Você edita o código ao lado de uma prévia ao vivo, salva versões, copia o markdown e exporta os diagramas em SVG ou PNG.
Como apago os meus dados?
Abra Manage account e escolha Delete account. Isso remove na hora seus repositórios, documentos, a conexão com o GitHub e o plano.
O seu próximo README está a um minuto
Conecte o GitHub, escolha um repositório e deixe o readme4me escrever.
Começar com o GitHub