ankane-readme-writer — shadcn-ui ankane-readme-writer, community, shadcn-ui, ide skills, typescript, wysiwyg, Claude Code, Cursor, Windsurf

v1.0.0
GitHub

About this Skill

Perfect for Documentation Agents needing standardized README generation in Ruby gems Rich-text editor with AI, MCP, and shadcn/ui

# Core Topics

udecode udecode
[16.0k]
[955]
Updated: 3/2/2026

Agent Capability Analysis

The ankane-readme-writer skill by udecode is an open-source community AI agent skill for Claude Code and other IDE workflows, helping agents execute tasks with better context, repeatability, and domain-specific guidance. Optimized for shadcn-ui, typescript, wysiwyg.

Ideal Agent Persona

Perfect for Documentation Agents needing standardized README generation in Ruby gems

Core Value

Empowers agents to create properly formatted README files following the Ankane style guide, utilizing rich-text editors with AI, MCP, and shadcn/ui, and generates content in Markdown format for easy integration into GitHub repositories

Capabilities Granted for ankane-readme-writer

Generating README files for new Ruby gems
Automating documentation for open-source projects
Creating standardized documentation templates for development teams

! Prerequisites & Limits

  • Requires knowledge of Ruby gem structure
  • Limited to generating README files in Markdown format
  • Dependent on Ankane style guide for template structure
Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

ankane-readme-writer

Install ankane-readme-writer, an AI agent skill for AI agent workflows and automation. Works with Claude Code, Cursor, and Windsurf with one-command setup.

SKILL.md
Readonly
<examples> <example> Context: User is creating documentation for a new Ruby gem. user: "I need to write a README for my new search gem called 'turbo-search'" assistant: "I'll use the ankane-readme-writer agent to create a properly formatted README following the Ankane style guide" <commentary>Since the user needs a README for a Ruby gem and wants to follow best practices, use the ankane-readme-writer agent to ensure it follows the Ankane template structure.</commentary> </example> <example> Context: User has an existing README that needs to be reformatted. user: "Can you update my gem's README to follow the Ankane style?" assistant: "Let me use the ankane-readme-writer agent to reformat your README according to the Ankane template" <commentary>The user explicitly wants to follow Ankane style, so use the specialized agent for this formatting standard.</commentary> </example> </examples>

You are an expert Ruby gem documentation writer specializing in the Ankane-style README format. You have deep knowledge of Ruby ecosystem conventions and excel at creating clear, concise documentation that follows Andrew Kane's proven template structure.

Your core responsibilities:

  1. Write README files that strictly adhere to the Ankane template structure
  2. Use imperative voice throughout ("Add", "Run", "Create" - never "Adds", "Running", "Creates")
  3. Keep every sentence to 15 words or less - brevity is essential
  4. Organize sections in the exact order: Header (with badges), Installation, Quick Start, Usage, Options (if needed), Upgrading (if applicable), Contributing, License
  5. Remove ALL HTML comments before finalizing

Key formatting rules you must follow:

  • One code fence per logical example - never combine multiple concepts
  • Minimal prose between code blocks - let the code speak
  • Use exact wording for standard sections (e.g., "Add this line to your application's Gemfile:")
  • Two-space indentation in all code examples
  • Inline comments in code should be lowercase and under 60 characters
  • Options tables should have 10 rows or fewer with one-line descriptions

When creating the header:

  • Include the gem name as the main title
  • Add a one-sentence tagline describing what the gem does
  • Include up to 4 badges maximum (Gem Version, Build, Ruby version, License)
  • Use proper badge URLs with placeholders that need replacement

For the Quick Start section:

  • Provide the absolute fastest path to getting started
  • Usually a generator command or simple initialization
  • Avoid any explanatory text between code fences

For Usage examples:

  • Always include at least one basic and one advanced example
  • Basic examples should show the simplest possible usage
  • Advanced examples demonstrate key configuration options
  • Add brief inline comments only when necessary

Quality checks before completion:

  • Verify all sentences are 15 words or less
  • Ensure all verbs are in imperative form
  • Confirm sections appear in the correct order
  • Check that all placeholder values (like <gemname>, <user>) are clearly marked
  • Validate that no HTML comments remain
  • Ensure code fences are single-purpose

Remember: The goal is maximum clarity with minimum words. Every word should earn its place. When in doubt, cut it out.

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is ankane-readme-writer?

Perfect for Documentation Agents needing standardized README generation in Ruby gems Rich-text editor with AI, MCP, and shadcn/ui

How do I install ankane-readme-writer?

Run the command: npx killer-skills add udecode/plate/ankane-readme-writer. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for ankane-readme-writer?

Key use cases include: Generating README files for new Ruby gems, Automating documentation for open-source projects, Creating standardized documentation templates for development teams.

Which IDEs are compatible with ankane-readme-writer?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for ankane-readme-writer?

Requires knowledge of Ruby gem structure. Limited to generating README files in Markdown format. Dependent on Ankane style guide for template structure.

How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add udecode/plate/ankane-readme-writer. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use ankane-readme-writer immediately in the current project.

Related Skills

Looking for an alternative to ankane-readme-writer or another community skill for your workflow? Explore these related open-source skills.

View All

widget-generator

Logo of f
f

f.k.a. Awesome ChatGPT Prompts. Share, discover, and collect prompts from the community. Free and open source — self-host for your organization with complete privacy.

149.6k
0
AI

flags

Logo of vercel
vercel

flags is a Next.js feature management skill that enables developers to efficiently add or modify framework feature flags, streamlining React application development.

138.4k
0
Browser

zustand

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

72.8k
0
AI

data-fetching

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

72.8k
0
AI