Skip to content
TrustedSkillsbeta
Back to all skills

Readme Generator

Checked
peopleforrester·vlatest·writing·MIT

Generates clear, concise README files quickly, streamlining project documentation and improving developer onboarding.

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 peopleforrester/claude-dotfiles --skill readme-generator -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

peopleforrester

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 peopleforrester/claude-dotfiles at db7caa0374.

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

Commit
db7caa0374
Manifest
skills/documentation/readme-generator/SKILL.md
Scanned
1 file, 269 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

The readme-generator skill creates README files from a given project. It can generate the basic structure, including sections for description, installation, usage, and contributing. This helps streamline documentation efforts for software projects and other initiatives needing clear instructions.

When to use it

  • Generating initial documentation for a new open-source project.
  • Creating a README file for a personal coding project.
  • Quickly documenting an internal tool or script within a team.
  • Updating existing README files with more structured information.

Key capabilities

  • Generates basic README structure
  • Includes sections for description, installation, usage, and contributing
  • Provides a starting point for comprehensive documentation

Example prompts

  • "Create a README file for my Python project called 'data-analyzer'."
  • "Generate a standard README with sections for setup and contribution guidelines."
  • “Make a simple readme for a Node.js script that scrapes data from a website.”

Tips & gotchas

The generated README is a template; you'll need to fill in the specific details relevant to your project. Consider providing detailed instructions or context within each section of the generated file.