mcpbeat

Create Readme

github/create-readme

Create a README.md file for the project

This is a copy. The original lives at christophacham/create-readme.

332 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
1
copies elsewhere
how many repositories repackaged it
37394
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/github/awesome-copilot --skill create-readme

The instruction itself

2 sections, as written by the author

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

  • Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  • 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
  • Do not overuse emojis, and keep the readme concise and to the point.
  • Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  • Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  • If you find a logo or icon for the project, use it in the readme's header.

Repackaged in 1 other repositories

same content, different owner
christophacham/agent-skills-library open on GitHub →

How to use it

Copy the folder

Take github/create-readme from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.