PaperclipOrg
Claude Agent Skill · by Github

Create Readme

The create-readme skill generates a comprehensive README.md file for software projects by analyzing the entire codebase and applying best practices from establi

Install
Terminal · npx
$npx skills add https://github.com/github/awesome-copilot --skill create-readme
Works with Paperclip

How Create Readme fits into a Paperclip company.

Create Readme drops into any Paperclip agent that handles this kind of work. Assign it to a specialist inside a pre-configured PaperclipOrg company and the skill becomes available on every heartbeat — no prompt engineering, no tool wiring.

S
SaaS FactoryPaired

Pre-configured AI company — 18 agents, 18 skills, one-time purchase.

$27$59
Explore pack
Source file
SKILL.md21 lines
Expand
---name: create-readmedescription: '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.md3. 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.