Skip to content
TrustedSkillsbeta
Back to all skills

Create Readme

Official
github·vlatest·writing·MIT

Automatically generates comprehensive README files for GitHub repositories based on project details and code analysis.

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 github/awesome-copilot --skill create-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

github

Matched to the vendor's own GitHub organisation.

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 failed 1 of 6 checks. A failure is not proof of bad intent; it means something in the code needs a human to look at it before you run it.

  • Declares what it does: failed

    No SKILL.md was found in the skill's directory.

    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 github/awesome-copilot at 6c4d33b9cf.

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

Commit
6c4d33b9cf
Manifest
skills/create-readme/SKILL.md
Scanned
0 files
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 create-readme skill generates a README file tailored to a project, including details like description, usage instructions, and contribution guidelines. It can pull information from existing code or documentation to create a structured and informative README.

When to use it

  • You're starting a new project and need a quick, well-formatted README.
  • You want to standardize documentation across multiple repositories.
  • Your project lacks a README, and you need one generated based on the project's files.
  • You're preparing your code for open-source contribution and want to ensure clarity.

Key capabilities

  • Automatically generates README content based on project structure.
  • Pulls relevant information from existing files or documentation.
  • Supports customization of sections like description, usage, and installation instructions.

Example prompts

  • "Generate a README for my Python library."
  • "Create a README file that includes installation steps and contribution guidelines."
  • "Write a README based on the contents of this GitHub repository."

Tips & gotchas

  • Ensure your project has enough structure or documentation to allow accurate content generation.
  • Review the generated README for accuracy, as it may not capture all nuances of your project.