Works with the AI Agents you already use

    Claude CodeClaude CodeCursorCursorCodex CLICodex CLIMuseMuseDotsDots+21 more

    readme visual design

    1

    Revamp GitHub README layouts, optimize visual hierarchy, and audit project assets for better developer conversion.

    Free

    Security scanned

    readme visual design

    Example session with this skill installed

    Review my README.md. The opening screen feels cluttered and I'm not sure if the badges are correct. Please provide a visual revamp.

    • Read your context and instructions
    • Compiled the readme visual design
    • Generated the document

    I have audited README.md and cross-referenced it with your package.json. The original layout placed a long disclaimer and outdated CI badges above the fold, pushing the actual tool description out of the first viewport. I have restructured the header, pruned broken badges, and moved the configuration tables into collapsible sections.

    README Revamp Audit

    SectionStatusChanges Made
    Opening ScreenOptimizedMoved visual anchor to top; compressed disclaimer.
    BadgesFixedRemoved 3 dead links; updated CI badge to match GitHub Actions.
    AssetsVerifiedVerified assets/demo.gif (2.4MB); added descriptive alt text.
    HierarchyImprovedConverted feature bullets to a comparison table.
    
    # Project Aurora
    
    Transform raw logs into structured JSON streams with zero latency.
    
    ![Output Demo](assets/demo.gif)
    
    [![CI](https://github.com/user/aurora/actions/workflows/ci.yml/badge.svg)](https://github.com/user/aurora/actions)
    [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
    
    ## Quick Start
    
    ```bash
    
    ```html
    npm install aurora-core
    
    <details> <summary><strong>View full configuration options</strong></summary> ```
    OptionTypeDefaultDescription
    bufferbooleantrueEnable internal stream buffering
    levelstringinfoMinimum log level to process
    </details>
    
    
    **Next steps**
    1. Run `git diff README.md` to review the structural changes.
    2. Open the generated `readme-preview.html` to see the side-by-side layout comparison.
    3. Provide a high-resolution screenshot of the CLI output to replace the placeholder in the asset gap list.
    

    readme-preview.html

    PDF · document

    Generated

    Example file from a real run - the skill writes it into your workspace.

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

    About this skill

    Your README is the storefront for your project, yet most are cluttered with technical debt, mismatched badges, and giant images that fail to load. This skill audits your existing documentation and restructures it for the critical first eight seconds of a reader's attention. It moves beyond simple formatting to fix information hierarchy, asset management, and visual proof of your code's output.

    What it does

    • Information Hierarchy Reorders elements to ensure the value proposition and visual anchor appear in the first two viewports.
    • Asset Audit Scans for broken image paths, oversized GIFs, and missing alt text while checking for dark mode compatibility.
    • Badge Cleanup Prunes redundant badges and ensures every icon links to a verifiable source like CI status or a license file.
    • Bilingual Syncing Maintains strict structural parity between primary and translated README files, ensuring identical heading and image counts.
    • Visual Previews Generates a side-by-side HTML comparison of the old and new layouts to verify the design before committing changes.

    How it works

    1. Analyze Ground Truth The agent reads the existing README alongside project manifests like package.json or go.mod to ensure commands and versions are accurate.
    2. Diagnose and Paradigm Pick It identifies the target audience and selects a proven opening structure based on available assets and project type.
    3. Restructure and Polish It applies layout changes, folds long content into <details> tags, and converts complex lists into comparison tables.
    4. Validation It runs internal scripts to check for broken links and hierarchy errors before delivering the final Markdown and a change log.

    Frameworks & tools

    This skill utilizes standard GitHub-flavored Markdown, python-markdown for previews, and specialized internal scripts for auditing image assets and link integrity.

    Why this beats prompting it yourself

    Generic prompts often turn technical documentation into vague marketing fluff or hallucinate CLI commands. This skill enforces strict technical accuracy by cross-referencing your actual source code and manifest files while maintaining the original developer's voice.

    Use cases

    • Open Source Launch Professionalize a repository's presentation to attract contributors and users.
    • Project Audit Identify and fix broken assets or outdated installation instructions in legacy docs.
    • Bilingual Maintenance Keep English and Chinese documentation perfectly synchronized in structure and assets.

    Known limitations

    This skill revamps existing READMEs only and will not generate a full documentation set from scratch. It does not create new logos, banners, or AI-generated images.

    Does not write docs from scratch. Only edits the README file. Cannot generate new visual assets or images. Requires python-markdown for HTML previews.

    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

    Free forever

    No account required to browse

    Trust & safety

    Security scan

    Security scan passed 22 days ago

    • Free with an Agensi account

    Requires

    Python
    project-name
    Node.js
    Git
    macOS

    Permissions

    Terminal / Shell
    Read Files
    Write Files
    Listed22 days ago

    What's inside

    Frequently Asked Questions

    The skill requires access to your repository's README file and project manifests (like `package.json` or `requirements.txt`) to ensure all technical commands and dependency references remain accurate during the redesign.

    No, this skill focuses on structure and layout optimization using your existing assets; it identifies broken or oversized images but does not generate new logos, banners, or custom illustrations.

    It uses a 'Bilingual Syncing' feature that ensures your primary and translated READMEs maintain identical structural parity, including matching heading levels, image placements, and link counts.

    Before any changes are committed, the agent generates a side-by-side HTML preview, allowing you to visually verify the hierarchy and layout improvements against your original version.

    The skill is designed for any agent environment that supports GitHub-flavored Markdown and has the capability to read local file structures, ensuring broad compatibility across most AI development platforms.

    New in Technical Documentation