Create Readme
Generate a polished, GitHub-ready README.md after reviewing the whole repo so newcomers and install instructions are clear.
Install
npx skills add https://github.com/ilteoood/harness --skill create-readmeWhat is this skill?
- Full-workspace pass before writing so features, setup, and structure match reality
- Structure and tone guided by proven Azure Samples and open-source README exemplars
- GFM plus GitHub admonition syntax for callouts without emoji overload
- Omits LICENSE, CONTRIBUTING, and CHANGELOG sections that belong in dedicated files
- Optional logo or icon in the README header when assets exist in the project
Adoption & trust: 1 installs on skills.sh; 2 GitHub stars; trending (+100% hot-view momentum).
Recommended Skills
Lark Doclarksuite/cli
Lark Wikilarksuite/cli
Opensource Guide Coachxixu-me/skills
Readme I18nxixu-me/skills
Doc Coauthoringanthropics/skills
Obsidian Markdownkepano/obsidian-skills
Journey fit
Primary fit
README work sits in Build/docs as the canonical shelf because you document the product once the codebase exists, even though you may revisit it before release. The skill’s entire output is project documentation (README.md), not code or infra—so docs is the primary subphase.
SKILL.md
READMESKILL.md - Create Readme
## 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.