Skip to content
TrustedSkillsbeta
Back to all skills

Readme Generate

Checked
manastalukdar·vlatest·writing·MIT

Generates comprehensive README files from project code and descriptions, streamlining documentation creation.

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 manastalukdar/ai-devstudio --skill readme-generate -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

manastalukdar

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 manastalukdar/claude-devstudio at e457c1d3b5.

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

Commit
e457c1d3b5
Manifest
skills/readme-generate/SKILL.md
Scanned
1 file, 686 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 README files for software projects. It can create a basic structure including sections like Description, Installation, Usage, and Contributing. The generated READMEs are intended to be a starting point that users can then customize further.

When to use it

  • You're starting a new open-source project and need a quick initial README file.
  • An existing project lacks a README or has an outdated one.
  • You want to standardize the README format across multiple projects in your organization.
  • You are documenting a personal coding project for learning purposes.

Key capabilities

  • Generates basic README structure.
  • Includes common sections like Description, Installation, Usage, and Contributing.
  • Provides a starting point for documentation.

Example prompts

  • "Create a README for a Python library called 'my_library' that helps with data analysis."
  • "Generate a README for a Javascript project named 'cool-app'."
  • “Write a basic README for a Go program that converts CSV files to JSON.”

Tips & gotchas

The generated README is a template; you will likely need to edit it to accurately reflect your project's specifics. Consider providing detailed information about dependencies and licensing for more complete documentation.