← All skills
readme-writing
70 / 100 · Review before installing
Check before installing.
By lev-os/agents (GitHub) · writing · 27 stars · scanned at commit 201a805
Craft professional README.md files for GitHub open source projects. Generates hero sections, installation instructions, feature tables, and architecture diagrams. Use when creating or revising a README, documenting a CLI tool, library, or open source project, or when user asks about README structure, badges, or project documentation.
Works with any agent that supports SKILL.md skills.
What this skill can do
Downloads and installs other software
The author does not mention this.
Found in 18 places.
Show 15 more
- skills-db/dev/readme-writing/references/CORE-TEMPLATES.md, line 115
curl -fsSL https://raw.githubusercontent.com/user/repo/main/install.sh | bash - skills-db/dev/readme-writing/references/CORE-TEMPLATES.md, line 122
curl -fsSL https://... | bash -s -- --easy-mode - skills-db/dev/readme-writing/references/CORE-TEMPLATES.md, line 125
curl -fsSL https://... | bash -s -- --version v1.0.0 - skills-db/dev/readme-writing/references/CORE-TEMPLATES.md, line 128
curl -fsSL https://... | sudo bash -s -- --system - skills-db/dev/readme-writing/references/CORE-TEMPLATES.md, line 135
brew install user/tap/tool - skills-db/dev/readme-writing/references/EXAMPLES.md, line 59
| macOS | Homebrew | `brew install tool` | - skills-db/dev/readme-writing/references/EXAMPLES.md, line 60
| Linux | apt | `sudo apt install tool` | - skills-db/dev/readme-writing/references/EXAMPLES.md, line 64
| Any | cargo | `cargo install tool` | - skills-db/dev/readme-writing/references/EXAMPLES.md, line 65
| Any | npm | `npm install -g tool` | - skills-db/dev/readme-writing/references/EXTENDED-TEMPLATES.md, line 194
curl -fsSL https://... | bash - skills-db/dev/readme-writing/references/PROMPTS.md, line 98
- Quick install: curl one-liner + cargo install alternative - skills-db/dev/readme-writing/references/PROMPTS.md, line 131
- Basic: curl ... | bash - skills-db/dev/readme-writing/references/PROMPTS.md, line 269
- Installation (cargo add / npm install / pip install) - skills-db/dev/readme-writing/references/QUICK-REFERENCE.md, line 24
| 2 | Curl one-liner above fold | `curl -fsSL ... \| bash` in hero | - skills-db/dev/readme-writing/references/QUICK-REFERENCE.md, line 104
curl -fsSL https://raw.githubusercontent.com/user/repo/main/install.sh | bash
Sends data to these websites: raw.githubusercontent.com, ...
The author does not mention this.
Found in 8 places.
Show 5 more
Changes files outside its own folder
The author does not mention this.
Found in 6 places.
Show 3 more
Safer alternatives
Low-risk skills in the same category (writing) that look related. Check that one does what you need.
Install
Paste this into your terminal. It downloads exactly the version we scanned, not whatever is newest.
if [ -e ~/.agents/skills/'readme-writing' ] || [ -L ~/.agents/skills/'readme-writing' ]; then echo 'A skill folder named readme-writing already exists — not replacing it' >&2; false; else d=$(mktemp -d) && git clone --quiet --filter=blob:none --no-checkout 'https://github.com/lev-os/agents' "$d" && git -C "$d" checkout --quiet '201a80515e1dc58addfda3cd9978907de2c944a6' -- 'skills-db/dev/readme-writing' && mkdir -p ~/.agents/skills && cp -R "$d"/'skills-db/dev/readme-writing' ~/.agents/skills/'readme-writing' && rm -rf "$d"; fi
Codex reads ~/.agents/skills directly. For Claude Code, Cursor, Copilot, Gemini CLI, Antigravity or OpenCode, also link it. For Claude Code: ln -s ~/.agents/skills/'readme-writing' ~/.claude/skills/'readme-writing' (other agents: ~/.cursor/skills, ~/.copilot/skills, ~/.gemini/skills, ~/.gemini/config/skills, ~/.config/opencode/skills). Or install through the finder skill, which does both.
Badge for your README
The badge for lev-os/agents shows the score of its lowest-scoring skill.
[](https://zalavijaysinh.github.io/skilltrust/repos/lev-os/agents/)
Score history
| Date | Version | Score |
|---|
| 2026-11-07 | 201a805 | 70 |