Claude Code create-readme skill for a Next.js quickstart
Inspect project scripts and files, then write a GitHub Markdown README covering purpose, startup, and configuration.
中文Install in Claude Code
Open Claude Code at the root of a Next.js template checkout. Have package.json, the file tree, and verified startup information available. Use a local demo project.
- Review `.claude/skills/create-readme/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.claude/skills/create-readme/` in your project and save the reviewed file as `.claude/skills/create-readme/SKILL.md`.
- Start Claude Code from that project's root, then select `/create-readme` in the slash menu.
Example task
Use create-readme to draft a Next.js README quickstart for a trail index demo. Check the development script before writing the page address and project purpose.
`Trail Index` · `README.md` · `Quickstart` · `package.json` · `{"scripts":{"dev":"next dev"}}`What to check
`README.md` gains a `Quickstart` with `http://localhost:3000` as the address of `Trail Index`, plus the startup step from the checked-in development script.
Original SKILL.md on GitHub · Updated
Frequently asked question
Should the README add a full license section?
Keep the license and contribution guidance in their dedicated files when present. Focus the README on purpose, startup, and common configuration.