Readme Craft

    1

    Generates accurate READMEs, API references, and changelogs directly from your source code and project context.

    $1

    Secure checkout via Stripe

    Money-back guarantee

    Converts to your local currency at checkout

    1 useSecurity scanned

    Works with the AI Agents you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseDotsDots+21 more

    Readme Craft

    Example session with this skill installed

    Audit my current README for the 'fast-cache' project. It's a Node.js library. Here is the content:

    Fast Cache. It makes things fast. Install with npm install fast-cache. Usage: cache.set('a', 1).

    • Read your context and instructions
    • Compiled the readme craft

    I have audited the documentation for fast-cache. The current version lacks a clear quick start, API reference, and contribution guidelines.

    Documentation Audit: fast-cache

    CheckScoreObservation
    Purpose is clear1Stated simply, but could be more descriptive.
    Install works2Command is clear and in a code block.
    Quick start exists0No full runnable example provided.
    Examples are real1Example is very minimal; needs context.
    API is documented0No parameter or return type information.
    No dead links2No links present to break.
    No stale versions2No versions listed.
    CONTRIBUTING exists0Missing entirely.
    License is stated0Missing entirely.

    Total Score: 8/18 (Weak)

    Highest Impact Fixes:

    Add a Quick Start: Include a 5-line block showing how to initialize the client and perform a get and set operation.
    2. Define the API: Create a table for cache.set(key, value, [ttl]) including types and the return value.
    3. Add License: Explicitly state the license (e.g., MIT) to allow others to use the code.

    Next steps

    • Provide the index.js source code so I can generate a full API docs reference.
    • Run the README mode to expand the "Why" and "Quick start" sections.
    • Add an MIT license file to the project root.

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

    About this skill

    Writing project documentation is a chore that developers often skip or rush, leading to stale READMEs and confused users. This skill automates the creation of high-quality documentation by analyzing your actual source code, comments, and project structure. It eliminates the friction of starting from a blank page and ensures your docs reflect what the code actually does.

    What it does

    • Documentation generation creates READMEs, API references, and CONTRIBUTING guides from scratch.
    • API mapping pulls signatures and return types directly from your source code to build tables.
    • Changelog management formats release notes using the Keep a Changelog standard.
    • Documentation auditing scores existing docs out of 18 and provides a prioritized list of fixes.
    • Triage assistance recommends a documentation roadmap based on your project type and audience.

    How it works

    1. Run the Triage mode to identify which files your project is missing.
    2. Provide source code or a project description to trigger the README or API docs modes.
    3. Review the drafted files, which are saved to a specific project slug directory.

    Frameworks & tools

    This skill is framework-agnostic and works with any language that uses standard documentation conventions like Markdown, OpenAPI, or JSDoc.

    Why this beats prompting it yourself

    Generic prompts often invent fake API methods or "hallucinate" installation steps that do not exist. This skill is hard-coded to only document what it finds in your actual files, ensuring your documentation is technically accurate and honest.

    Use cases

    • Drafting a README for a new open-source library before the first release.
    • Generating a structured API reference for a REST or GraphQL service.
    • Auditing a legacy project to find missing setup steps or dead links.
    • Creating a standardized CONTRIBUTING guide for a growing team.

    Known limitations

    Does not verify if third-party status badges or install counts are accurate. Requires the user to provide code or descriptions as it cannot browse external private repositories.

    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

    1 use

    Times used to date

    Money-back guarantee

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

    Trust & safety

    Security scan

    Security scan passed 3 days ago

    Listed3 days ago

    What's inside

    Frequently Asked Questions