Skip to content
TrustedSkillsbeta
Back to all skills

Accelint Readme Writer

Checked
gohypergiant·vlatest·writing·Apache-2.0

This AI instantly generates readable and comprehensive README files, saving developers time and ensuring clear project documentation.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add gohypergiant/agent-skills --skill accelint-readme-writer -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

gohypergiant

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned gohypergiant/agent-skills at fe1ce07cb2.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
fe1ce07cb2
Manifest
skills/accelint-readme-writer/SKILL.md
Scanned
9 files, 2,051 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill generates structured README files for software projects, translating raw code or project details into professional documentation. It formats output with standard Markdown conventions to ensure clarity and consistency across repositories.

When to use it

  • You need to document a new open-source library or tool quickly without writing docs from scratch.
  • Your team requires standardized formatting for multiple microservices or submodules within a monorepo.
  • You want to convert technical specifications or code comments into a polished README.md for public consumption.

Key capabilities

  • Generates full Markdown README files with appropriate headers and sections.
  • Structures content logically, including installation instructions, usage examples, and feature lists.
  • Adapts tone and detail level based on the input project context.

Example prompts

  • "Create a README for my Python data processing library that includes setup steps and a code example."
  • "Write a documentation file for a new React component suite highlighting its key features and API usage."
  • "Generate a README for a Rust CLI tool, including installation commands and configuration options."

Tips & gotchas

Ensure you provide sufficient context about the project's purpose and specific technical requirements to avoid generic output. The skill relies on accurate input details; vague descriptions may result in incomplete or inaccurate documentation sections.