MCP.directory

readme-gen

by openclaw
0
0
Source

Generate beautiful README.md files with badges, install instructions, and API docs. Use when starting new projects.

Install

mkdir -p .claude/skills/readme-gen && curl -L -o skill.zip "https://mcp.directory/api/skills/download/8313" && unzip -o skill.zip -d .claude/skills/readme-gen && rm skill.zip

Installs to .claude/skills/readme-gen

About this skill

README Gen

Your project has no README. Or worse, it has one that says "TODO: write readme". This tool generates complete README files from your codebase. Badges, installation steps, API documentation, examples. A README that makes people actually want to use your project.

One command. Zero config. Just works.

Quick Start

npx ai-readme

What It Does

  • Generates a complete README from your project structure
  • Adds appropriate badges (npm, license, build status)
  • Creates installation instructions for your package manager
  • Documents your API based on exports
  • Includes usage examples from your code or tests

Usage Examples

# Generate README for current project
npx ai-readme

# Specify output file
npx ai-readme --output README.md

# Include specific sections
npx ai-readme --sections intro,install,api,examples

# Generate for a CLI tool
npx ai-readme --type cli

Best Practices

  • Run at project start - Easier to maintain a README than to write one from scratch later
  • Customize the intro - AI writes decent intros but your voice is better
  • Add real examples - Generated examples are generic. Show your actual use cases.
  • Keep badges minimal - Nobody needs 15 badges. Pick the 3-5 that matter.

When to Use This

  • Starting a new open source project
  • Publishing a package to npm
  • Your README is embarrassingly empty
  • Restructuring a project and need fresh docs

Part of the LXGIC Dev Toolkit

This is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.

Find more:

Requirements

No install needed. Just run with npx. Node.js 18+ recommended.

npx ai-readme --help

How It Works

The tool reads your package.json, analyzes your source files for exports and CLI commands, checks for existing docs or examples, then generates a structured README with all the sections a good project needs.

License

MIT. Free forever. Use it however you want.

More by openclaw

View all skills by openclaw →

seedream-image-gen

openclaw

Generate images via Seedream API (doubao-seedream models). Synchronous generation.

3460

ffmpeg-cli

openclaw

Comprehensive video/audio processing with FFmpeg. Use for: (1) Video transcoding and format conversion, (2) Cutting and merging clips, (3) Audio extraction and manipulation, (4) Thumbnail and GIF generation, (5) Resolution scaling and quality adjustment, (6) Adding subtitles or watermarks, (7) Speed adjustment (slow/fast motion), (8) Color correction and filters.

9437

garmin-connect

openclaw

Syncs daily health and fitness data from Garmin Connect into markdown files. Provides sleep, activity, heart rate, stress, body battery, HRV, SpO2, and weight data.

10835

himalaya

openclaw

CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).

10732

gog

openclaw

Google Workspace CLI for Gmail, Calendar, Drive, Contacts, Sheets, and Docs.

12430

nano-pdf

openclaw

Edit PDFs with natural-language instructions using the nano-pdf CLI.

19229

You might also like

flutter-development

aj-geddes

Build beautiful cross-platform mobile apps with Flutter and Dart. Covers widgets, state management with Provider/BLoC, navigation, API integration, and material design.

9521,094

drawio-diagrams-enhanced

jgtolentino

Create professional draw.io (diagrams.net) diagrams in XML format (.drawio files) with integrated PMP/PMBOK methodologies, extensive visual asset libraries, and industry-standard professional templates. Use this skill when users ask to create flowcharts, swimlane diagrams, cross-functional flowcharts, org charts, network diagrams, UML diagrams, BPMN, project management diagrams (WBS, Gantt, PERT, RACI), risk matrices, stakeholder maps, or any other visual diagram in draw.io format. This skill includes access to custom shape libraries for icons, clipart, and professional symbols.

846846

ui-ux-pro-max

nextlevelbuilder

"UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 8 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient."

571699

godot

bfollington

This skill should be used when working on Godot Engine projects. It provides specialized knowledge of Godot's file formats (.gd, .tscn, .tres), architecture patterns (component-based, signal-driven, resource-based), common pitfalls, validation tools, code templates, and CLI workflows. The `godot` command is available for running the game, validating scripts, importing resources, and exporting builds. Use this skill for tasks involving Godot game development, debugging scene/resource files, implementing game systems, or creating new Godot components.

548492

nano-banana-pro

garg-aayush

Generate and edit images using Google's Nano Banana Pro (Gemini 3 Pro Image) API. Use when the user asks to generate, create, edit, modify, change, alter, or update images. Also use when user references an existing image file and asks to modify it in any way (e.g., "modify this image", "change the background", "replace X with Y"). Supports both text-to-image generation and image-to-image editing with configurable resolution (1K default, 2K, or 4K for high resolution). DO NOT read the image file first - use this skill directly with the --input-image parameter.

673466

fastapi-templates

wshobson

Create production-ready FastAPI projects with async patterns, dependency injection, and comprehensive error handling. Use when building new FastAPI applications or setting up backend API projects.

514280

Related MCP Servers

Browse all servers
EChartsECharts

Generate ECharts visualizations as PNG images from JavaScript configs, perfect for data visualization and report generat

71 tools
Figma to React NativeFigma to React Native

Easily convert Figma designs to code. Extract components from Figma files, generate hierarchies & metadata for smooth Fi

70 tools
Unified Diff GeneratorUnified Diff Generator

Use our diff checker online to compare files on line. Generate unified diffs with precise 3-line context for easy code r

31 tools
Agile Planner MCP ServerAgile Planner MCP Server

Agile Planner MCP Server — AI project management tool and agile backlog generator offering automated backlog creation an

30 tools
Akave StorageAkave Storage

Akave Storage: Manage buckets, upload/download files, and generate signed URLs with automatic text cleaning on Akave's S

20 tools
Theta HealthTheta Health

Theta Health MCP Server offers EHR interoperability solutions, enabling AI assistants to access and manage diverse healt

21 tools

Stay ahead of the MCP ecosystem

Get weekly updates on new skills and servers.