Skills
.Work. You
Rest

ankane-readme-writer

Community

Generate Ankane-style READMEs

Software Engineering#documentation#technical writing#readme#ruby gems#ankane style
Authorgvkhosla
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation and updating of README files for Ruby gems, ensuring they adhere to the concise, imperative, and well-structured Ankane style.

Core Features & Use Cases

  • Ankane Template Adherence: Strictly follows the standard section order (Header, Installation, Quick Start, Usage, Options, Contributing, License).
  • Imperative Voice & Brevity: Enforces short sentences (<= 15 words) and imperative verbs for clear instructions.
  • Use Case: When launching a new Ruby gem, use this Skill to quickly generate a professional, easy-to-understand README that follows established community best practices.

Quick Start

Use the ankane-readme-writer skill to create a README for the 'my-awesome-gem' gem.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: ankane-readme-writer
Download link: https://github.com/gvkhosla/compound-engineering-pi/archive/main.zip#ankane-readme-writer

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.