Create Readme

Name: Create Readme
Author: ilteoood

ilteoood/harness

218 installs
2 repo stars
Updated July 24, 2026
ilteoood/harness

This is a copy of create-readme by github - installs and ranking accrue to the original listing.

Generate a polished, GitHub-ready README.md after reviewing the whole repo so newcomers and install instructions are clear.

About

Create-readme is an agent skill that acts as a senior engineer documenting your repository: it reviews the entire workspace, then drafts a comprehensive README.md that is appealing, scannable, and informative. Solo and indie builders use it when a repo is real enough to ship or share but still has a thin or missing README—common right after scaffolding, before a first public push, or when onboarding collaborators. The workflow explicitly benchmarks structure and tone against reference READMEs from Azure Samples and established open-source projects, then keeps prose concise and avoids dumping legal or contribution policy into the README. Formatting targets GitHub Flavored Markdown and community admonition patterns so install steps, architecture notes, and warnings read well on GitHub. You still own accuracy of commands and secrets; the skill focuses on presentation and completeness of the primary entry doc.

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

Create Readme by the numbers

218 all-time installs (skills.sh)
+30 installs in the week ending Jul 25, 2026 (Skillselion tracking)
Data as of Jul 25, 2026 (Skillselion catalog sync)

npx skills add https://github.com/ilteoood/harness --skill create-readme

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

[![Listed on Skillselion](https://skillselion.com/badge/skills/ilteoood/harness/create-readme.svg)](https://skillselion.com/skills/ilteoood/harness/create-readme)

Installs	218
repo stars	★ 2
Last updated	July 24, 2026
Repository	ilteoood/harness ↗

What it does

Generate a polished, GitHub-ready README.md after reviewing the whole repo so newcomers and install instructions are clear.

Files

SKILL.mdMarkdownGitHub ↗

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.