📖

README Generator

Verified

by Community

Create comprehensive README files with project description, installation steps, usage examples, API docs, and badges.

readmedocumentationmarkdowndevelopment

README Generator Skill

When asked to generate a README:

  1. Analyze the project structure:
ls -la
cat package.json 2>/dev/null | python3 -c "import json,sys;d=json.load(sys.stdin);print(d.get('name',''),d.get('description',''))"
  1. Generate a README with these sections:

Template

# Project Name

Brief description.

## Features

- Feature 1
- Feature 2

## Installation

npm install project-name


## Usage

// code example


## API

| Method | Description |
|--------|-------------|

## Contributing

## License

Guidelines

  • Read the project to understand what it does
  • Include actual code examples, not placeholders
  • Add relevant badges (build, version, license)
  • Keep installation instructions tested and accurate