Skip to main content
skill CX Codex

readme-generator · patricio0312rev — Claude Code skill: what it does, how to install

readme-generator generates structured README.md files with status badges, setup steps, API tables, and contribution guides. Useful when documenting a new repository.

MIT 313 installs ★ 64 updated 2026-01-12

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add patricio0312rev/skills --skill readme-generator -a claude-code
Open on GitHub

What readme-generator does

The skill inspects your codebase first. Then it compiles a full README.md following a step-by-step workflow. It outlines project features, configures Shields.io badges, and writes setup steps for npm, pnpm, or yarn. The generated file includes folder trees, environment tables, code snippets, and troubleshooting tips.

The contributing section defaults to Conventional Commits with basic setup instructions for test runs and builds.

The built-in template heavily targets Node.js and TypeScript packages. If your repository does not expose an API client or custom environment flags, you will need to trim those generated tables manually.

What it helps with

  • generate a structured README.md file for a repository
  • document API parameters and environment variables in clean tables
  • add setup and contribution guides with Conventional Commits
  • generate status badges for CI builds, test coverage, and licensing

Example prompts for the agent

  • Generate a README for this repository
  • Create project setup docs and API documentation
  • Draft a readme template with install instructions

How to install readme-generator

1Skills CLI (Vercel)

npx skills add patricio0312rev/skills --skill readme-generator -a claude-code

2Manually: put the files in place

~/.claude/skills/readme-generator/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/readme-generator/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about readme-generator

How to install readme-generator in Claude Code?

Run npx skills add patricio0312rev/skills --skill readme-generator -a claude-code in your terminal.

What does readme-generator do?

It analyzes your project files and outputs a README.md with badges, install commands, usage snippets, API tables, and contribution guidelines.

Which commit conventions does it document?

The contributing section uses Conventional Commits with standard prefixes: feat:, fix:, docs:, test:, and chore:.

Source text

SKILL.md · MIT
---
name: readme-generator
description: Generates comprehensive README files with badges, installation, usage, API docs, and contribution guidelines. Use when users request "README", "project documentation", "readme template", "documentation generator", or "project setup docs".
---

# README Generator

Create comprehensive, professional README documentation for projects.

## Core Workflow

1. **Analyze project**: Identify type and features
2. **Add header**: Title, badges, description
3. **Document setup**: Installation and configuration
4. **Show usage**: Examples and API
5. **Add guides**: Contributing, license
6. **Include extras**: Screenshots, roadmap

## README Template

```markdown
# Project Name

[![npm version](https://img.shields.io/npm/v/package-name.svg)](https://www.npmjs.com/package/package-name)
[![Build Status](https://github.com/username/repo/workflows/CI/badge.svg)](https://github.com/username/repo/actions)
[![Coverage](https://codecov.io/gh/username/repo/branch/main/graph/badge.svg)](https://codecov.io/gh/username/repo)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue.svg)](https://www.typescriptlang.org/)

Brief description of what this project does and who it's for. One to two sentences that capture the essence of the project.

## Features

- ✨ Feature one with brief description
- 🚀 Feature two with brief description
- 🔒 Feature three with brief description
- 📦 Feature four with brief description

## Demo

![Demo GIF](https://example.com/demo.gif)

[Live Demo](https://demo.example.com) | [Documentation](https://docs.example.com)

## Quick Start

\`\`\`bash
npx create-project-name my-app
cd my-app
npm run dev
\`\`\`

## Installation

### Prerequisites

- Node.js 18.0 or higher
- npm 9.0 or higher (or pnpm/yarn)

### Package Manager

\`\`\`bash
# npm
npm install package-name

# pnpm
pnpm add package-name

# yarn
yarn add package-name
\`\`\`

### From Source

\`\`\`bash
git clone https://github.com/username/repo.git
cd repo
npm install
npm run build
\`\`\`

## Usage

### Basic Usage

\`\`\`typescript
import { something } from 'package-name';

const result = something({
  option1: 'value',
  option2: true,
});

console.log(result);
\`\`\`

### Advanced Usage

\`\`\`typescript
import { createClient, type Config } from 'package-name';

const config: Config = {
  apiKey: process.env.API_KEY,
  timeout: 5000,
  retries: 3,
};

const client = createClient(config);

// Async operation
const data = await client.fetch('/endpoint');
\`\`\`

### With React

\`\`\`tsx
import { Provider, useData } from 'package-name/react';

function App() {
  return (
    <Provider apiKey={process.env.API_KEY}>
      <MyComponent />
    </Provider>
  );
}

function MyComponent() {
  const { data, loading, error } = useData('key');

  if (loading) return <Spinner />;
  if (error) return <Error message={error.message} />;

  return <div>{data.value}</div>;
}
\`\`\`

## API Reference

### `createClient(config)`

Creates a new client instance.

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `apiKey` | `string` | required | Your API key |
| `baseUrl` | `string` | `'https://api.example.com'` | API base URL |
| `timeout` | `number` | `30000` | Request timeout in ms |
| `retries` | `number` | `3` | Number of retry attempts |

**Returns:** `Client`

### `client.fetch(endpoint, options?)`

Fetches data from the specified endpoint.

\`\`\`typescript
const data = await client.fetch('/users', {
  method: 'GET',
  headers: { 'X-Custom': 'value' },
});
\`\`\`

### `client.create(endpoint, data)`

Creates a new resource.

\`\`\`typescript
const user = await client.create('/users', {
  name: 'John Doe',
  email: '[email protected]',
});
\`\`\`

## Configuration

### Environment Variables

| Variable | Description | Required |
|----------|-------------|----------|
| `API_KEY` | Your API key | Yes |
| `API_URL` | Custom API URL | No |
| `DEBUG` | Enable debug mode | No |

### Configuration File

Create a `config.json` in your project root:

\`\`\`json
{
  "apiKey": "your-api-key",
  "environment": "production",
  "features": {
    "caching": true,
    "logging": false
  }
}
\`\`\`

## Examples

### Example 1: Basic CRUD

\`\`\`typescript
// Create
const user = await client.create('/users', { name: 'John' });

// Read
const users = await client.fetch('/users');

// Update
await client.update(\`/users/\${user.id}\`, { name: 'Jane' });

// Delete
await client.delete(\`/users/\${user.id}\`);
\`\`\`

### Example 2: Error Handling

\`\`\`typescript
try {
  const data = await client.fetch('/protected');
} catch (error) {
  if (error instanceof AuthError) {
    console.error('Authentication failed');
  } else if (error instanceof NetworkError) {
    console.error('Network error:', error.message);
  } else {
    throw error;
  }
}
\`\`\`

More examples in the [examples directory](./examples).

## Architecture

\`\`\`
src/
├── client/          # Client implementation
├── hooks/           # React hooks
├── utils/           # Utility functions
├── types/           # TypeScript types
└── index.ts         # Main export
\`\`\`

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

### Development Setup

\`\`\`bash
# Clone the repository
git clone https://github.com/username/repo.git

# Install dependencies
npm install

# Run tests
npm test

# Start development
npm run dev
\`\`\`

### Commit Convention

We use [Conventional Commits](https://www.conventionalcommits.org/):

- `feat:` New feature
- `fix:` Bug fix
- `docs:` Documentation
- `test:` Tests
- `chore:` Maintenance

## Roadmap

- [x] Initial release
- [x] TypeScript support
- [ ] React Native support
- [ ] Offline mode
- [ ] Plugin system

See the [open issues](https://github.com/username/repo/issues) for a full list of proposed features.

## FAQ

<details>
<summary><strong>How do I get an API key?</strong></summary>

Visit [our dashboard](https://dashboard.example.com) to create an account and generate an API key.
</details>

<details>
<summary><strong>Is there a rate limit?</strong></summary>

Yes, the free tier allows 1000 requests per hour. See our [pricing page](https://example.com/pricing) for higher limits.
</details>

<details>
<summary><strong>Does it work with Next.js?</strong></summary>

Yes! We have full support for Next.js including App Router and Server Components.
</details>

## Troubleshooting

### Common Issues

**Error: API key is invalid**

Make sure your API key is correctly set in the environment variables and hasn't expired.

**Error: Network timeout**

Increase the timeout value in your configuration or check your network connection.

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a history of changes.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- [Library 1](https://example.com) - For the amazing feature
- [Library 2](https://example.com) - For inspiration
- All our [contributors](https://github.com/username/repo/graphs/contributors)

## Support

- 📧 Email: [email protected]
- 💬 Discord: [Join our community](https://discord.gg/example)
- 🐦 Twitter: [@username](https://twitter.com/username)
- 📖 Documentation: [docs.example.com](https://docs.example.com)

---

Made with ❤️ by [Your Name](https://github.com/username)
```

## Badge Examples

```markdown
<!-- Build Status -->
[![CI](https://github.com/user/repo/actions/workflows/ci.yml/badge.svg)](https://github.com/user/repo/actions/workflows/ci.yml)

<!-- npm -->
[![npm](https://img.shields.io/npm/v/package.svg)](https://www.npmjs.com/package/package)
[![npm downloads](https://img.shields.io/npm/dm/package.svg)](https://www.npmjs.com/package/package)

<!-- Coverage -->
[![codecov](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)](https://codecov.io/gh/user/repo)

<!-- License -->
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

<!-- Language -->
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?logo=javascript&logoColor=black)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)

<!-- Framework -->
[![React](https://img.shields.io/badge/React-20232A?logo=react&logoColor=61DAFB)](https://reactjs.org/)
[![Next.js](https://img.shields.io/badge/Next.js-000000?logo=next.js&logoColor=white)](https://nextjs.org/)
[![Node.js](https://img.shields.io/badge/Node.js-339933?logo=node.js&logoColor=white)](https://nodejs.org/)

<!-- Package Manager -->
[![pnpm](https://img.shields.io/badge/pnpm-F69220?logo=pnpm&logoColor=white)](https://pnpm.io/)

<!-- PRs Welcome -->
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

<!-- Maintenance -->
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/user/repo/graphs/commit-activity)

<!-- Custom Shields.io -->
[![Custom Badge](https://img.shields.io/badge/custom-badge-blue)](https://example.com)
```

## CONTRIBUTING.md Template

```markdown
# Contributing to Project Name

Thank you for your interest in contributing! This document provides guidelines and steps for contributing.

## Code of Conduct

Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).

## How Can I Contribute?

### Reporting Bugs

- Check existing issues first
- Use the bug report template
- Include reproduction steps
- Provide environment details

### Suggesting Features

- Check existing feature requests
- Use the feature request template
- Explain the use case
- Consider implementation approach

### Pull Requests

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/my-feature`
3. Make your changes
4. Write/update tests
5. Run the test suite: `npm test`
6. Commit with conventional commits: `git commit -m 'feat: add new feature'`
7. Push to your fork: `git push origin feature/my-feature`
8. Open a Pull Request

## Development Setup

\`\`\`bash
# Clone your fork
git clone https://github.com/your-username/repo.git

# Add upstream remote
git remote add upstream https://github.com/original-owner/repo.git

# Install dependencies
npm install

# Create a branch
git checkout -b feature/my-feature
\`\`\`

## Coding Standards

- Follow existing code style
- Use TypeScript strict mode
- Write meaningful commit messages
- Add tests for new features
- Update documentation as needed

## Testing

\`\`\`bash
# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Run specific test file
npm test -- path/to/test.ts
\`\`\`

## Questions?

Feel free to open an issue or reach out on Discord.
```

## CHANGELOG.md Template

```markdown
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- New feature description

### Changed
- Change description

### Fixed
- Bug fix description

## [1.2.0] - 2024-01-15

### Added
- Add new authentication method
- Add TypeScript support for config files

### Changed
- Improve error messages
- Update dependencies

### Fixed
- Fix memory leak in connection pool
- Fix race condition in cache invalidation

## [1.1.0] - 2024-01-01

### Added
- Add retry mechanism for failed requests
- Add timeout configuration option

### Deprecated
- Deprecate `oldMethod()` in favor of `newMethod()`

## [1.0.0] - 2023-12-15

### Added
- Initial release
- Core API functionality
- React hooks
- TypeScript types

[Unreleased]: https://github.com/user/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/user/repo/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/user/repo/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/user/repo/releases/tag/v1.0.0
```

## Best Practices

1. **Start with value**: Lead with what the project does
2. **Quick start first**: Get users running quickly
3. **Show, don't tell**: Include code examples
4. **Keep updated**: Sync with code changes
5. **Use badges**: Show project health
6. **Add visuals**: Screenshots and diagrams
7. **Link related**: Connect to other docs
8. **Be consistent**: Follow established patterns

## Output Checklist

Every README should include:

- [ ] Project title and description
- [ ] Badges (build, version, license)
- [ ] Features list
- [ ] Quick start / Installation
- [ ] Usage examples
- [ ] API documentation
- [ ] Configuration options
- [ ] Contributing guidelines
- [ ] License information
- [ ] Support/contact info

© patricio0312rev · MIT · patricio0312rev/skills

Similar skills

All skills for Writing and docs →

readme-generator by other authors comes first.

readme-generator Jeremy Longshore Writes README files on its own once you mention readme generator or readme in a prompt. It walks through the steps and produces configs along the way. CX Codex +1 273installs readme-generator wedsamuel1230 readme-generator generates README.md files for Arduino, ESP32, and RP2040 projects. Use it when a working project needs clear GitHub documentation. CX Codex +1 147installs readme-blueprint-generator official github The readme-blueprint-generator skill reads project documentation and builds a structured README.md. It fits repositories that keep project guidance in .github/copilot and copilot-instructions.md. CX Codex +1 9,662installs update-readme Samarth Gupta update-readme rewrites an existing README.md using the current code, git log and changelog. Useful once the docs drift away from what the repo actually does. CX Codex +1 ★ 276repo stars indexion-readme trkbt10 The indexion-readme skill assembles a project README from templates, doc comments and static files, then checks that your edits only added text. CX Codex +1 5,100installs create-readme-section centminmod The create-readme-section command for Claude Code generates README sections based on project files. Create installation instructions, API references, or contribution guides. CX Codex +1 ★ 2,744repo stars create-readme official github The create-readme skill reviews a project and creates a structured README.md. Use it when the repository needs clear documentation based on its actual files and code. CX Codex +1 19,081installs readme-optimization Samuel Berthe readme-optimization — a skill for Claude Code and Codex that audits a repository README and rewrites it into an actionable landing page. It verifies installation steps against code and removes vanity badges. CX Codex +1 13,600installs

From the same set148

The whole set →
openapi-generator openapi-generator — a skill for Claude Code, Codex, Cursor, and other AI code editors that generates OpenAPI 3.0/3.1 specifications directly from Express, Next.js, Fastify, Hono, or NestJS routes. CX Codex +1 320installs api-test-suite-generator api-test-suite-generator scans your route definitions and generates API test suites with Jest, Vitest or Supertest. Useful when the endpoints exist but the tests do not. CX Codex +1 319installs prisma-migration-assistant prisma-migration-assistant plans safe Prisma schema changes, data backfills, and rollbacks. Useful for column renames, type conversions, and zero-downtime database updates. CX Codex +1 316installs vscode-workspace-setup vscode-workspace-setup writes a .vscode folder into the repo: shared editor settings, extension recommendations, build tasks and debug configs. Useful when formatting and lint drift between teammates. CX Codex +1 313installs cypress-playwright-setup cypress-playwright-setup — a skill for Claude Code, Codex, Cursor, and other agents that sets up E2E testing with Cypress or Playwright: page objects, fixtures, and CI integration. CX Codex +1 313installs page-layout-builder page-layout-builder builds page shells for dashboards, auth, settings, and CRUD flows. Use it when a new screen needs routes, navigation, and state placeholders. CX Codex +1 312installs curl-command-generator curl-command-generator turns Express, Next.js or Fastify route definitions into cURL commands you can paste into a terminal, auth headers and JSON bodies included. CX Codex +1 311installs data-integrity-auditor data-integrity-auditor is a Claude Code skill that finds database integrity problems and suggests fixes. It responds to requests about orphaned rows, broken relationships, and data quality. CX Codex +1 306installs

Project sponsors

Companies that keep this analytics open