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.
What the skill teaches
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.
Capabilities
- 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
About
- Publisher
- Luong Nguyen
- Tool
- Documentation
Works with
Install
- Run this to add it to Any client:
npx skills@1.7.0 add https://github.com/luongnv89/skills --skill readme-generator
What's inside
- references/anti-slop-rules.md
- references/final-report.md
- references/landing-section.md
- references/section-templates.md
- references/step-reports.md
MCP servers and skills can run code on your computer and act on your data. Review the source before installing.
Details
| Fact | Value | Source |
|---|---|---|
| Type | Skill | |
| Tool | Documentation | |
| Publisher | Luong Nguyen | source |
| Official status | Not stated in its documentation | |
| Needs an API key or sign-in | Not stated in its documentation | |
| Includes scripts | No | source |
| Platforms | Not stated in its documentation | |
| AI clients | Claude Code, Cursor, Codex, Devin Desktop | source |
| Licence | MIT | source |
| Pricing | Not stated in its documentation | |
| Activity | Last commit Nov 18, 2026147 GitHub starsDownload data not available (not on npm or PyPI) | source |
| Links | Repository Website |
Also listed under: Documentation
Sources
- GitHub repositorygithub.com/luongnv89/skills · Backs: AI clients, Activity, LicenceNov 11, 2026
- Web pageraw.githubusercontent.com · Backs: Licence, PublisherNov 19, 2026
- Skill file (SKILL.md)github.com/luongnv89/skillsNov 19, 2026
- Folder in the repository (readme-generator)github.com/luongnv89/skills · Backs: Includes scriptsNov 19, 2026