SkillAgentSearch skills...

create-readme

Create a README.md file for the project

Install / Use

npx skills add github/awesome-copilot --skill create-readme

Installs into whichever agent you are using.

About this skill
📄

SKILL.md

Installable skill definition

Quality Score

67/100

Supported Platforms

Universal

Our assessment of create-readme

create-readme scores 67/100 on our quality scale, 1448th of 2,189 Development & Engineering skills we index.

Its SKILL.md is 1.3 KB long, lightly structured (2 headings) and no code examples: moderately detailed.

With 39,348 GitHub stars, it is one of the more widely adopted skills in the catalogue.

Substance
20/30
Structure
5/20
Description
8/15
Adoption
20/20
Freshness
15/15

Maintenance, license and trust

  • The repository was last updated 2 days ago, so create-readme is actively maintained.
  • It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
  • Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.

Safety scan

No issues found

Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands.

Automated pattern scan on 2026-09-26. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.

create-readme compared with similar skills

All 4 of these similar skills score higher than create-readme; compare them before choosing.

SkillScoreStarsUpdatedFormat
create-readme (this skill)by github6739.3k2d agoSKILL.md
Agent-Reachby Panniantong10085.6k11d agoCLAUDE.md
ai-job-searchby MadsLorentzen10044.0k5d agoCLAUDE.md
claude-howtoby luongnv8910041.7ktodayCLAUDE.md
algorithmic-artby anthropics100177.9k4d agoSKILL.md

Frequently asked questions

How do I install create-readme?
Run npx skills add github/awesome-copilot --skill create-readme. The install tabs above show the steps for each supported agent.
Which AI agents does create-readme work with?
It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
Is create-readme safe to use?
Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
Is create-readme still maintained?
The repository was last updated 2 days ago, so create-readme is actively maintained.

name: create-readme description: 'Create a README.md file for the project'

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
    • https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
    • https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
    • https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
    • https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.

Related Skills

View on GitHub
GitHub Stars39.3k
CategoryDevelopment
Updated2d ago
Forks5.0k

Languages

JavaScript

Trust signals

100/100

From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.

No cautions