How do I install the Readme Generator skill?

Run npx skillmds@latest add tomevault-io/readme-generator-9 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Readme Generator safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readme Generator?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readme Generator free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readme Generator?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readme Generator by tomevault-io — Agent Skill

Name: Readme Generator
Author: tomevault-io

File contents

README Generator

Quick Start

Generate a README based on project type:

# Detect project type
ls package.json && echo "Node.js project" || \
ls setup.py pyproject.toml && echo "Python project" || \
ls go.mod && echo "Go project"

Instructions

Step 1: Analyze Project

Gather project information:

Project name (from package.json, pyproject.toml, etc.)
Description (from manifest or git)
Main language and framework
Key features (scan source files)
Dependencies (from manifest files)

Step 2: Select Template

Choose template based on project type:

Type	Template	Key Sections
Library	library	Installation, API, Examples
CLI Tool	cli	Installation, Commands, Options
Web App	webapp	Features, Setup, Deployment
API	api	Endpoints, Authentication, Examples

Step 3: Generate Core Sections

Title and Description:

# Project Name

Brief one-line description of what the project does.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)

Installation:

## Installation

\`\`\`bash
npm install project-name
# or
pip install project-name
\`\`\`

Usage:

## Usage

\`\`\`javascript
const project = require('project-name');

// Basic example
project.doSomething();
\`\`\`

Step 4: Add Project-Specific Content

Include relevant sections:

Features: Bullet list of key capabilities
API Reference: For libraries
Configuration: For configurable tools
Examples: Real-world use cases
Contributing: How to contribute
License: License information

Step 5: Add Badges and Links

Common badges:

![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)
![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
![npm version](https://badge.fury.io/js/package-name.svg)

README Structure

Essential Sections (all projects)

Title and Description
Installation
Quick Start / Usage
License

Recommended Sections

Features - What makes it useful
Documentation - Link to full docs
Examples - Common use cases
Contributing - How to help
Support - Where to get help

Optional Sections

Requirements - System dependencies
Configuration - Setup options
Troubleshooting - Common issues
Changelog - Recent changes
Acknowledgments - Credits

Advanced

For detailed information, see:

Templates - README templates by project type
Best Practices - Documentation standards and style guide

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: readme-generator-9description: Creates comprehensive README files with templates for different project types. Use when creating README, project documentation, or getting started guides.---# README Generator## Quick StartGenerate a README based on project type:```bash# Detect project typels package.json && echo "Node.js project" || \ls setup.py pyproject.toml && echo "Python project" || \ls go.mod && echo "Go project"```## Instructions### Step 1: Analyze ProjectGather project information:- Project name (from package.json, pyproject.toml, etc.)- Description (from manifest or git)- Main language and framework- Key features (scan source files)- Dependencies (from manifest files)### Step 2: Select TemplateChoose template based on project type:| Type | Template | Key Sections ||------|----------|--------------|| Library | library | Installation, API, Examples || CLI Tool | cli | Installation, Commands, Options || Web App | webapp | Features, Setup, Deployment || API | api | Endpoints, Authentication, Examples |### Step 3: Generate Core Sections**Title and Description:**```markdown# Project NameBrief one-line description of what the project does.[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)```**Installation:**```markdown## Installation\`\`\`bashnpm install project-name# orpip install project-name\`\`\````**Usage:**```markdown## Usage\`\`\`javascriptconst project = require('project-name');// Basic exampleproject.doSomething();\`\`\````### Step 4: Add Project-Specific ContentInclude relevant sections:- **Features**: Bullet list of key capabilities- **API Reference**: For libraries- **Configuration**: For configurable tools- **Examples**: Real-world use cases- **Contributing**: How to contribute- **License**: License information### Step 5: Add Badges and LinksCommon badges:```markdown![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)![npm version](https://badge.fury.io/js/package-name.svg)```## README Structure### Essential Sections (all projects)1. **Title and Description**2. **Installation**3. **Quick Start / Usage**4. **License**### Recommended Sections5. **Features** - What makes it useful6. **Documentation** - Link to full docs7. **Examples** - Common use cases8. **Contributing** - How to help9. **Support** - Where to get help### Optional Sections10. **Requirements** - System dependencies11. **Configuration** - Setup options12. **Troubleshooting** - Common issues13. **Changelog** - Recent changes14. **Acknowledgments** - Credits## AdvancedFor detailed information, see:- [Templates](reference/templates.md) - README templates by project type- [Best Practices](reference/best-practices.md) - Documentation standards and style guide---> Converted and distributed by [TomeVault](https://tomevault.io/claim/armanzeroeight) — claim your Tome and manage your conversions.

Frequently asked questions

Readme Generator