README
/README
Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.
- Author
- gabrielSantosLima ↗
- Repository
- harness ↗
- Licence
- MIT
- Last repository change
- 08.11.2026
Assessment and security
- Files in this package
- 2
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 08.11.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.
Original author description
Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.
How it works
- 1. Inspect the repository
- 2. Ask
- 3. Resolve the metadata
- 4. Write the English README
- 5. Write translations
- 6. Preserve existing content
- 7. Validate
- 8. Hand off
- Boundaries
SKILL.md preview
--- name: README description: Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README. --- # README Write or restructure a README using the template in `references/template.md`. The English file is canonical; translations mirror its structure. ## 1. Inspect the repository Collect: - existing `README.md`, `README.pt-BR.md`, `README.es.md`; - the license file and type; - logo candidates (`assets/logo.png`, `assets/images/logo.png`, `icon.png`, ...); - the project description from a manifest, if any; - the default branch and remote (`git remote get-url origin`); - existing workflows under `.github/workflows/`. Never infer features. Use what the repository and the user provide. ## 2. Ask Ask in one round: 1. **Languages**: English only, English + Portuguese, English + Spanish, or all three. Default to the languages that already exist; if none, ask. 2. **Logo**: none, or a path. Suggest a detected candidate. 3. **Badges**: CI, Release, Docs, License. Default: Release and License, plus CI when `ci.yml` exists, plus Docs when a Pages workflow exists. 4. **Sections**: Features, Requirements, Getting started, Usage, Configuration, Development, Testing, Releasing, Contributing, License. Default to the ones the repository can support with real content. Do not add a section you cannot fill truthfully. ## 3. Resolve the metadata - `owner/repo` from the remote. Accept SSH and HTTPS URLs. - Project name from the user or the manifest. Use the display name, not the package slug. - One-line description from the user or the manifest. - License: use the file name (`LICENSE`) and the detected type (`MIT`, `Apache-2.0`, ...). ## 4. Write the English README Follow `references/template.md`: ```html <div align="center"> <img src="<logo>" alt="<name>" width="200" /> # <name> <description> [badges] [language selector] </div> ``` Then the chosen sections. ## 5. Write translations Create `README.pt-BR.md` and/or `README.es.md` only when chosen. - Mirror the section order and links. - Translate prose; keep commands, code, file names and URLs unchanged. - Keep the same language selector in every file, in this order: `[English](README.md) | [Português (Brasil)](README.pt-BR.md) | [Español](README.es.md)` - Do not translate badges, version numbers or brand names. ## 6. Preserve existing content - Read the current README before writing. - Keep useful commands, features and notes; move them into the new structure. - Do not delete content without explicit approval. - Show a diff before writing when a README already exists. ## 7. Validate - Title matches the project display name. - Badge URLs point to the real repository and existing workflows. - The license badge points to `LICENSE`. - Every language link points to an existing file. - Section headings are consistent across languages. - No secret, token, local path or agent attribution appears. - Relative links resolve. ## 8. Hand off Report the files created or changed, the chosen languages, the badges, the sections included and anything the user must fill in. Do not commit, push or tag unless the user asks. ## Boundaries - Never invent features, commands or screenshots. - Never add a language file without the matching selector entry. - Never overwrite unrelated sections without approval. - Never add AI attribution or tool mentions.
Files in this package (2)
- SKILL.md 3 KB
- references/template.md 2 KB
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · gabrielSantosLima/harness | 90 | MIT |
| tamaplus/josjis-code | 100 | MIT |
| sorah/config | 100 | MIT |
| Dhananjay-JSR/skills | 100 | MIT |
| Jeff-Kazzee/github-skills | 100 | MIT |
| jasonm4130/claude-skills | 100 | MIT |
| samplexbro/agentsmesh | 100 | MIT |
| tushaarmehtaa/tushar-skills | 100 | MIT |
| samplexbro/agentsmesh | 100 | MIT |
Database snapshot: 13.11.2026 · package version 77ef7e7f93bb (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100configure-readme
README.md with logo, badges, features, tech stack sections. Use when creating a README, auditing missing sections, or adding shields.io badges. - 100readme-docs
Creates or updates the README.md of a software project (backend, frontend, mobile, library, CLI or anything else) following a documentation standard with mandatory, conditional and optional sections. Use it when the user asks to document a project, create or improve the README,… - 100github-repo-readme
Audit, create, or polish a GitHub project repository README from verified code, manifests, scripts, tests, workflows, and existing docs. Use for repository landing pages, project introductions, badges, screenshots, quickstarts, README structure, or comparisons with strong… - 100readme-forge
Write a professional bilingual README for the project in the current folder (README.md in English plus README.fr.md in French, linked to each other) with badges, real screenshots and GIFs captured from the running project, an MIT LICENSE, CONTRIBUTING.md, SECURITY.md, and the… - 100ni-readme-guide
Create, rewrite, beautify, or audit GitHub repository READMEs as a synchronized Chinese-default and English pair, with reciprocal language links, verified functional badges, project-native visuals, real proof, concise quick starts, and maintainable Markdown. Use when a user asks… - 96create-readme
Use when generating or updating a project README.md or CHANGELOG.md.