readme-generator
A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details.
O que a skill ensina
A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details. In a Git repository it first syncs with origin, stashing tracked changes, and stops to ask if that fails. It then reads the manifest, licence, changelog, docs, tests and command-line definitions to collect facts with their source, backs up the old README, and writes the opening section followed by detail sections in a set order, keeping every original section. A self-check covers order, traced commands, working links and filler text. Missing facts become placeholders, and nothing is committed unless asked.
O que faz
- Write a README from facts in the repository
- Restructure an existing README without dropping sections
- Back up the previous README before writing
- Check commands and links in the result
Sobre
- Publicador
- Luong Nguyen
- Ferramenta
- Documentation
Funciona com
Instalação
- Execute este comando para adicionar ao Qualquer cliente:
npx skills@1.7.0 add https://github.com/luongnv89/skills --skill readme-generator
O que tem dentro
- references/anti-slop-rules.md
- references/final-report.md
- references/landing-section.md
- references/section-templates.md
- references/step-reports.md
Servidores MCP e skills podem executar código no seu computador e agir sobre os seus dados. Revise o código-fonte antes de instalar.
Detalhes
| Fato | Valor | Fonte |
|---|---|---|
| Tipo | Skill | |
| Ferramenta | Documentation | |
| Publicador | Luong Nguyen | fonte |
| Status oficial | Não informado na documentação | |
| Exige chave de API ou login | Não informado na documentação | |
| Inclui scripts | Não | fonte |
| Plataformas | Não informado na documentação | |
| Clientes de IA | Claude Code, Cursor, Codex, Devin Desktop | fonte |
| Licença | MIT | fonte |
| Preço | Não informado na documentação | |
| Atividade | Último commit em 18 de nov. de 2026147 estrelas no GitHubDados de download indisponíveis (não está no npm nem no PyPI) | fonte |
| Links | Repositório Site |
Também listado em: Documentation
Fontes
- Repositório no GitHubgithub.com/luongnv89/skills · Comprova: Clientes de IA, Atividade, Licença11 de nov. de 2026
- Página webraw.githubusercontent.com · Comprova: Licença, Publicador19 de nov. de 2026
- Arquivo da skill (SKILL.md)github.com/luongnv89/skills19 de nov. de 2026
- Pasta no repositório (readme-generator)github.com/luongnv89/skills · Comprova: Inclui scripts19 de nov. de 2026