SkillsAdd

github/awesome-copilot · Official

create-readme

Create a README.md file for the project

All-time #1045 Trending #5136 First seen Feb 25, 2026
8-week activity · all time api

Installation

$ npx skills add github/awesome-copilot --skill create-readme
View on skills.sh ↗ GitHub repository ↗

Summary

  • Generates comprehensive README.md files for projects with professional structure and formatting.
  • Analyzes entire project workspace to create contextually accurate, well-organized documentation Follows proven open-source README patterns with clear sections for setup, usage, and key features Uses GitHub Flavored Markdown and admonition syntax for enhanced readability and visual hierarchy Balances detail with conciseness, avoiding unnecessary sections and excessive emoji while maintaining professional tone

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

remotion-create Similar name
remotion-dev/skills

Create a new Remotion video

74.5K installs
create-auth Similar name
better-auth/skills 29.9K installs
recipe-create-presentation Similar name
googleworkspace/cli

Create a new Google Slides presentation and add initial slides.

29.3K installs
recipe-create-gmail-filter Similar name
googleworkspace/cli

Create a Gmail filter to automatically label, star, or categorize incoming messages.

28.3K installs
recipe-create-doc-from-template Similar name
googleworkspace/cli

Copy a Google Docs template, fill in content, and share with collaborators.

27.7K installs
recipe-create-shared-drive Similar name
googleworkspace/cli

Create a Google Shared Drive and add members with appropriate roles.

27.3K installs

Security audits

Partner security reviews for this skill.

agent-trust-hub SAFE

Analyzed Feb 25, 2026

This skill generates a project README.md file by analyzing the local workspace and referencing external templates from trusted repositories. It operates as intended for a documentation tool and does not contain malicious code or behaviors.

snyk MEDIUM

Analyzed Feb 25, 2026

[MEDIUM] W011: Third-party content exposure detected (indirect prompt injection risk).

socket Score 0.9000 · 0 alerts

Analyzed Mar 18, 2026

  • license 1
  • maintenance 1
  • quality 0.9
  • supply chain 1
  • vulnerability 1

0 alerts

Also in this package

Other skills from github/awesome-copilot · top by installs.

npx skills add github/awesome-copilot
git-commit 44.5K excalidraw-diagram-generator 29.1K documentation-writer 26.2K multi-stage-dockerfile 23.4K prd 22.9K gh-cli 21.9K refactor 21.6K java-springboot 19.9K playwright-generate-test 18K conventional-commit 16.1K

Browse all from github/awesome-copilot

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 38.8K
License LICENSE
Default branch main
Open issues 21
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Declared agents github-copilot

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,331 B
  • docs SUMMARY.md 60 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 18,142 installs

SKILL.md

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

  1. Do not overuse emojis, and keep the readme concise and to the point.
  2. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  3. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  4. If you find a logo or icon for the project, use it in the readme's header.