Create Readme

create-readme

Generates comprehensive README.md files for projects with professional structure and formatting.

github/awesome-copilot·18.8Kinstalls39.7KstarsDocumentation

SKILL.md

Full skill instructions

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:
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.

Install skill

Copy and run in your terminal

npx -y skills add https://github.com/github/awesome-copilot --skill create-readme

View on GitHub

create-readme

More Documentation skills

View all

Documentation

lark-wiki

Manage Lark Wiki spaces, members, nodes, and document organization hierarchies.

17.5K 457.5K

View

Documentation

lark-openapi-explorer

Discover and call native Lark OpenAPI endpoints from official documentation when existing skills fall short.

17.5K 451K

View

Documentation

supabase-postgres-best-practices

Postgres performance optimization and best practices from Supabase. Use this skill when writing, reviewing, or optimizing Postgres queries, schema designs, or database configurations.

2.7K 431.1K

View

Documentation

writing-beats

writing beats

276.6K 414.7K

View

Documentation

writing-shape

writing shape

276.6K 414.2K

View

Documentation

writing-fragments

writing fragments

276.6K 413.9K

View

Documentation

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K

View

Documentation

writing-skills

Test-driven documentation for creating reusable agent techniques, patterns, and reference guides.

295.4K 205.7K

View

Documentation

firebase-auth-basics

Guide for setting up and using Firebase Authentication. Use this skill when the user's app requires user sign-in, user management, or secure data access using auth rules.

462 163.8K

View

Documentation

Builds and deploys Firebase SQL Connect (aka Firebase Data Connect) backends with PostgreSQL securely. Use when designing schemas with tables and relations, writing authorized queries and mutations, configuring real-time data updates, or generating type-safe SDKs. Use when you need a relational database with Firebase, or when the user mentions SQL Connect or Data Connect.

462 158.3K

View

Documentation

vercel-react-view-transitions

Guide for implementing smooth, native-feeling animations using React's View Transition API (`<ViewTransition>` component, `addTransitionType`, and CSS view transition pseudo-elements). Use this skill whenever the user wants to add page transitions, animate route changes, create shared element animations, animate enter/exit of components, animate list reorder, implement directional (forward/back) navigation animations, or integrate view transitions in Next.js. Also use when the user mentions view transitions, `startViewTransition`, `ViewTransition`, transition types, or asks about animating between UI states in React without third-party animation libraries.

31.9K 143K

View