Back to Recipes

README Generator

Create professional README files with badges, installation steps, and usage examples.

DocumentationEasy5 minclaudecursor

Use This Recipe

skillsy recipe use readme --name my-readme
Parameters
--name

Name for your generated skill

Default: my-readme

--project-dir

Project directory

Default: .

--badges

Include badges: true, false

Default: true

Output

This recipe generates the following files:

SKILL.mdmanifest.jsonREADME.md
Compatible Agents
claudecursor
README Generator | Skillsy Recipes