Skip to content
AI & Agents
Skill

/create-readme

Create a README.md file for the project

BOOST
@githubgithub@github
From plugin
awesome-copilot
41k200 skills200 agents

Claude Code

$ npx -y skills add github/awesome-copilot --skill create-readme --agent claude-code

SKILL.md

create-readme.SKILL.md
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.

Read it on GitHub ↗
Stats
PythonJavaScriptNodeReactC#PostgreSQLAWSAzureLinuxGitHubMarkdownMCP
41,020
Stars
5,333
Forks
Active
Maintenance
JavaScript
Language
MIT
License
Last commit
Created
Added

Repo: github/awesome-copilot

In this plugin
200 agents200 skills
See everything inside
@github
Ships withawesome-copilot

A community-created collection of custom agents, instructions, skills, hooks, workflows, and plugins to supercharge your GitHub Copilot experience.

41k200 skills200 agents
Get the whole plugin

Stars on GitHub

Momentum

stars in total
40.7k
Star history of github/awesome-copilot on GitHub, a chart by star-history.com
See what's trending this week

Other skills on awesome-copilot.

acreadiness-assess

acreadiness-assess

Run the AgentRC readiness assessment on the current repository and produce a static HTML dashboard at reports/index.html. Wraps…

awesome-copilot
@github@githubInstall Skill
See all 200 skills in awesome-copilot

More skills from other plugins.

1password

1password

Set up and use 1Password CLI for sign-in, desktop integration, and reading or injecting secrets.

openclaw2w393k
@openclaw@openclawInstall Skill

Questions about create-readme.

Which coding agents can use create-readme?
create-readme installs in Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, OpenCode and Windsurf with the skills CLI, using each agent's flag shown on this page. Flowy's auto-invocation, which fires a skill when your prompt matches, runs in Claude Code only.