Skip to content
TrustedSkillsbeta
Back to all skills

Generate Readme

Checked
cowork-os·vlatest·writing·MIT

Automatically creates clear, concise README files from project code and descriptions for easy 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 cowork-os/cowork-os --skill generate-readme -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

cowork-os

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 cowork-os/cowork-os at 3bf276fac9.

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

Commit
3bf276fac9
Manifest
resources/skills/generate-readme/SKILL.md
Scanned
1 file, 42 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 automatically generates README files for software projects. It creates a basic structure including sections like project description, installation instructions, usage examples, and contribution guidelines. The generated README can be customized with specific details about the project.

When to use it

  • Creating a new repository on GitHub or GitLab and needing a starting point for documentation.
  • Quickly generating a README when you're focused on coding and don’t have time for detailed writing.
  • Standardizing the format of README files across multiple projects within a team.
  • Generating initial documentation for open-source contributions.

Key capabilities

  • Automatic generation of standard README sections.
  • Customizable content based on project details.
  • Suitable for various software project types.

Example prompts

  • "Generate a README for my Python library called 'my_library' that does image processing."
  • “Create a basic README file for a Node.js web application.”
  • "I need a README for a Go program that scrapes data from websites; include a section on dependencies."

Tips & gotchas

The generated README provides a foundation, and you’ll likely want to add more specific details relevant to your project. Consider providing the AI agent with as much context about your project as possible for better results.