Works with the AI Agents you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseDotsDots+21 more

    README

    1

    Standardize repository front pages with technical accuracy, verifiable code snippets, and reader-first structure.

    $3

    Secure checkout via Stripe

    Money-back guarantee

    Converts to your local currency at checkout

    Security scanned
    README

    README

    Example session with this skill installed

    Analyze this repository and write a Standard tier README. It is a Python CLI tool for resizing images named 'pix-shrink'. It needs Pillow and Python 3.10.

    • Read your context and instructions
    • Compiled the readme

    I have analyzed the repository structure and manifests. I've drafted a Standard tier README that prioritizes the installation of pix-shrink and provides a verifiable quick start example.

    README.md

    pix-shrink

    Resize images from the command line without losing metadata. Useful for batch processing web assets while maintaining EXIF data.

    Requirements

    • Python 3.10 or later
    • Pillow 10.0 or later

    Installation

    Install the package using pip

    pip install pix-shrink
    

    Quick start

    To shrink an image to a specific width while maintaining aspect ratio:

    pix-shrink input.jpg --width 800 --output small.jpg
    

    Expected output

    Reading input.jpg...
    Resizing to 800x600
    Saved small.jpg (1.2MB -> 145KB)
    

    Usage

    Batch processing
    Shrink all images in a directory to 50% scale.

    pix-shrink ./images/ --scale 0.5 --suffix _thumb
    

    Configuration

    NameRequiredDefaultWhat it does
    PIX_SHRINK_QUALITYNo85Sets the JPEG output quality (1-100)

    Values are read from environment variables.

    Where to go next

    NeedDestination
    Learn moreDocumentation site
    Reproducible bugIssue tracker
    Usage questionDiscussions
    Terms of useLICENSE

    Next steps

    1. Add the PIX_SHRINK_QUALITY variable to your .env.example.
    2. Verify the documentation site URL in the "Where to go next" table.
    README.md

    Connects securely to your tools. The creator never sees your data.

    About this skill

    Maintain the gateway to your repository with a tool that treats the README as a functional entry point rather than a static document. This skill addresses the problem of fragmented documentation, unclear setup paths, and incomplete project front-pages that drive away potential users. It ensures every visitor can answer five critical questions: what the project does, who it is for, how to run it, how to verify success, and where to go next.

    What it does

    • Drafts multi-tier READMEs by selecting between minimal, standard, or advanced templates based on project complexity.
    • Audits and scores existing files against strict clarity and structure rules to identify missing setup steps or unclear value propositions.
    • Extracts facts from manifests like package.json, pyproject.toml, and .env.example to ensure installation steps are technically accurate.
    • Standardizes prose by enforcing active voice, second-person imperatives, and removing filler words that obscure technical meaning.
    • Verifies runnability by checking that every code snippet is self-contained and includes expected output for user comparison.

    How it works

    1. Fact collection through scanning repository manifests, entry points, and CI workflows to identify requirements and commands.
    2. Tier selection where the agent picks a prose budget and section list based on whether the project is a script, library, or platform.
    3. Drafting and editing using a reader-first order that prioritizes the "first success" over internal code architecture.
    4. Validation using a bundled Python checker to enforce sentence length limits and syntax-correct code fences.

    Frameworks & tools

    This skill works with any repository type including Python, Node.js, Rust, Go, and Docker. It includes a specific check_readme.py script requiring Python 3.8 or later for automated linting.

    Why this beats prompting it yourself

    Generic prompts often produce "marketing fluff" and invented facts that lead to broken installation steps. This skill follows a rigid methodology that prevents hallucinated commands and forces the inclusion of observable success criteria for every code example.

    Use cases

    • New project scaffolding to create a standard-compliant front page before the first commit.
    • Documentation audits to score existing READMEs and identify why newcomers are struggling to install the tool.
    • Plugin documentation for agent skills or IDE extensions that require specific host-loading instructions.
    • Monorepo management to build a high-level map that routes users to specific package documentation.

    Known limitations

    Does not generate API reference pages, long-form tutorials, or CHANGELOG entries. Relies on GitHub-flavored Markdown standards. Requires Python 3.8+ to run the optional automated checker script.

    Requires Python 3.8+ for the optional check_readme.py script. Does not generate full API references or tutorials. Optimized for GitHub-flavored Markdown.

    How to use

    1. 1

      Connect your agent to the Agensi MCP

      Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup

    2. 2

      Sign in to Agensi

      Your agent shows a sign-in link. Sign in and click Allow.

    3. 3

      Ask for what you need

      Your agent loads this skill and uses it on your task. It always asks before any payment.

    Reviews

    No reviews yet

    Be one of the first to try it. Every listed skill goes through the trust checks below.

    Security scanned

    Checked by our 8-point scan before listing

    Fresh listing

    Recently published to Agensi

    Money-back guarantee

    Doesn't do what its page promises? You get your money back.

    Trust & safety

    Security scan

    Security scan passed 1 month ago

    Requires

    Python

    Permissions

    Terminal / Shell
    Write Files
    Read Files
    Listed1 month ago
    Updated1 month ago

    What's inside

    Frequently Asked Questions

    This skill prevents 'documentation rot' by extracting installation commands directly from your project's manifest files (like package.json or pyproject.toml), ensuring your README reflects the actual code rather than outdated manual notes.

    The skill is compatible with any repository type, including Python, Node.js, Rust, Go, and Docker; however, the optional 'check_readme.py' linting script requires Python 3.8 or later to execute.

    No, this skill is focused on the 'gateway' experience, providing standardized high-level overviews and setup instructions; it does not generate deep API references, long-form tutorials, or changelogs.

    You receive the core README generation logic, a set of multi-tier templates (minimal, standard, and advanced), and a specialized Python-based linting script for automated structure and syntax validation.

    The agent analyzes your repository's complexity to choose a 'prose budget' and section list, ensuring a simple script doesn't get an over-engineered README, while a complex platform gets the depth it requires.

    New in Technical Documentation