Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
A skill your agent uses when creating or rewriting README.md for projects.
Install Readme Generator
$ npx skills add serejaris/personal-corp-os --skill readme-generator -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install serejaris/personal-corp-os readme-generator --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/serejaris/personal-corp-os.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/readme-generator .claude/skills/readme-generator && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "readme-generator" agent skill from https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generator into .claude/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generatorType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add serejaris/personal-corp-os --skill readme-generator -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install serejaris/personal-corp-os readme-generator --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/serejaris/personal-corp-os.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/readme-generator .agents/skills/readme-generator && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "readme-generator" agent skill from https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generator into .agents/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add serejaris/personal-corp-os --skill readme-generator -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install serejaris/personal-corp-os readme-generator --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/serejaris/personal-corp-os.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/readme-generator .cursor/skills/readme-generator && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "readme-generator" agent skill from https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generator into .cursor/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/serejaris/personal-corp-os.git --path skills/readme-generator--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add serejaris/personal-corp-os --skill readme-generator -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install serejaris/personal-corp-os readme-generator --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/serejaris/personal-corp-os.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/readme-generator .gemini/skills/readme-generator && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "readme-generator" agent skill from https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generator into .gemini/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install serejaris/personal-corp-os readme-generatorInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add serejaris/personal-corp-os --skill readme-generator -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/serejaris/personal-corp-os.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/readme-generator .github/skills/readme-generator && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "readme-generator" agent skill from https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generator into .github/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add serejaris/personal-corp-os --skill readme-generator -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install serejaris/personal-corp-os readme-generator --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/serejaris/personal-corp-os.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/readme-generator .opencode/skills/readme-generator && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "readme-generator" agent skill from https://github.com/serejaris/personal-corp-os/tree/main/skills/readme-generator into .opencode/skills/readme-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-generator", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
readme-generator- GitHub stars
- 229
- Token cost
- ~1.2k tokens
- SKILL.md length
- 340 words
- Files
- 4 (incl. assets)
- Skills in repo
- 36
- Repo updated
- First seen
- Licence
- MIT
At a glance
A skill your agent uses when creating or rewriting README.md for projects.
- Works in 4 steps: Research → Analyze Project → Identify Project Type → …
- Rewriting README.md for projects
- SKILL.md covers When to Use, Process, Step 1: Research and Step 2: Analyze Project, plus 7 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Readme Generator is an agent skill from serejaris/personal-corp-os. Use when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.
Its SKILL.md is about 1.2k tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including assets (for example `README.md` and `README.ru.md`).
It sits in Development, covering Technical documentation. The repository describes itself as: Personal Corp OS — управление личной компанией через AI-агентов: задачи вне головы, отделы вместо памяти, недельное ретро. Открытые скиллы для Claude Code и Codex. The licence is MIT.
When your agent uses it
- Rewriting README.md for projects
- Tasks that involve Technical documentation
Example prompts
- “write README”
- “create README”
- “update README”
- “/readme-generator”
Workflow steps
4 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 95e36c3. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown and dot).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Readme Generator loads about 1.2k tokens when it runs. Until then it costs about 48 tokens; SKILL.md has 340 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from serejaris/personal-corp-os at commit 95e36c3, republished under its MIT licence (© serejaris). 340 words, ~1,208 tokens.
Download SKILL.mdSave it as
.claude/skills/readme-generator/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.- name
- readme-generator
- description
- Use when creating or rewriting README.md for projects. Triggers on "write README", "create README", "update README". Creates human-focused documentation with proper structure.
README Generator
Generate human-focused README files following current best practices.
Core principle: README is for humans, not agents. Research → Analyze → Write.
Model recommendation: Use Task tool with model: haiku for README generation — faster and cheaper for documentation tasks.
When to Use
- Creating README for new project
- Rewriting outdated README
- User asks "write/create/update README"
Process
digraph readme_flow {
rankdir=TB;
"1. Research best practices via Exa" [shape=box];
"2. Analyze project structure" [shape=box];
"3. Identify project type" [shape=diamond];
"4. Write README with appropriate sections" [shape=box];
"5. Commit and push if requested" [shape=box];
"1. Research best practices via Exa" -> "2. Analyze project structure";
"2. Analyze project structure" -> "3. Identify project type";
"3. Identify project type" -> "4. Write README with appropriate sections";
"4. Write README with appropriate sections" -> "5. Commit and push if requested";
}Step 1: Research
Always search first for current README best practices:
mcp__exa__web_search_exa: "best practices README.md {year} {project_type}"Look for:
- Current trends in README structure
- Examples from similar projects
- What sections are essential vs optional
Step 2: Analyze Project
Read these files to understand the project:
CLAUDE.mdor existing docspackage.json/pyproject.toml/Cargo.toml- Main entry points
- Test files (understand features)
Step 3: Identify Project Type
| Type | Key Sections |
|---|---|
| CLI Tool | Usage examples, Options table, Installation |
| Library/SDK | API overview, Quick start, Examples |
| Web App | Features, Quick start, Architecture diagram |
| Full-stack | Architecture, Quick start both parts, Tech stack |
| AI/ML | Model info, Requirements (GPU), Examples |
Step 4: README Structure
Essential (all projects):
# Project Name
**One-line value proposition.**
Brief description (2-3 sentences max).
## What It Does / Features
- Bullet points of capabilities
- Focus on VALUE not implementation
## Quick Start
Minimal steps to get running (< 5 commands)
## Requirements
- Runtime versions
- System requirements
- Disk space if significant
## Usage
Examples for common cases
## Tech Stack (if non-trivial)
Table format preferred
## LicenseOptional by project type:
| Section | When to Include |
|---|---|
| Architecture diagram | Web apps, full-stack, complex systems |
| Project Structure | Open source, contribution expected |
| API Reference | Libraries, SDKs (or link to docs) |
| Related Skills | If Claude Code skills exist |
| CLI Options table | CLI tools |
| Configuration | Apps with config files |
| Known Limitations | If significant gotchas exist |
Writing Style
DO:
- Start with value, not implementation
- Use active voice
- Keep sentences short
- Include runnable examples
- Write for humans scanning quickly
DON'T:
- Include API reference for internal use
- Write walls of text
- Use jargon without explanation
- Include every possible option
Related Skills Section
If project has Claude Code skills, add:
## Related Skills
| Skill | Trigger | What it does |
|-------|---------|--------------|
| `skill-name` | "trigger phrase" | Brief description |Quick Reference
| Project has... | Include |
|---|---|
| Web UI | Screenshot or architecture |
| CLI | Options table, examples |
| API | Endpoint summary (not full docs) |
| AI/ML | Model, hardware requirements |
| Claude skills | Related Skills table |
| Complex arch | Mermaid diagram |
Common Mistakes
| Mistake | Fix |
|---|---|
| API docs dump | Link to separate file or remove |
| No quick start | Add "clone → run" in < 5 steps |
| Wall of text | Use bullets, tables, code blocks |
| Missing requirements | Always list runtime + system reqs |
| Generic description | Start with specific value prop |
Example Structure (Full-stack App)
# Project Name
**Value proposition in one line.**
Brief description.
## Features
- Feature 1
- Feature 2
## Quick Start
\`\`\`bash
./start.sh
\`\`\`
## Requirements
- OS/hardware
- Runtime versions
## Tech Stack
| Layer | Stack |
|-------|-------|
## Architecture
\`\`\`mermaid
flowchart...
\`\`\`
## Project Structure
\`\`\`
project/
├── ...
\`\`\`
## Related Skills
| Skill | Trigger | Description |
## Development
How to test, build
## License© serejaris, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 3 other files (assets) in skills/readme-generator of serejaris/personal-corp-os.
- SKILL.md
- README.md
- README.ru.md
- assets/illustration.png
Open the folder on GitHubat commit 95e36c3
Compare with similar skills
Readme Generator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Readme Generator this skillserejaris/personal-corp-os | 229 | — | ~1.2k | Automated safety check: Pass | MIT | |
| Diagram Designcathrynlavery/diagram-design | 48k | 1 repos | ~7.6k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 | |
| Draw.io Diagram StudioAgents365-ai/drawio-skill | 10k | — | ~2.4k | Automated safety check: Notes | MIT |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
Dark Architecture Diagram Builder
Cocoon-AI/architecture-diagram-generator
Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.
More from serejaris/personal-corp-os
All 36 skills in this repoWeekly Planning
serejaris/personal-corp-os
A skill your agent uses when the user is transitioning from a completed retro into a weekly plan, choosing weekly outcomes, scheduling a full ISO week, or asking for "план на неделю", "weekly…
Gh Issues
serejaris/personal-corp-os
A skill your agent uses when creating, searching, updating, or managing GitHub issues via CLI.
Product Data Audit
serejaris/personal-corp-os
A skill your agent uses when auditing a product, business, or project ecosystem — analyzing data sources, decision loops, bottlenecks, and implementation contours.
Tg Bot Ops
serejaris/personal-corp-os
A skill your agent uses when operating, debugging, deploying, or monitoring a Telegram bot or Telegram-to-agent gateway.
Audit Agent Rules
serejaris/personal-corp-os
Audits the agent rules in the current folder (AGENTS.md, nested AGENTS.md files) and the skill descriptions the agent sees at start, then reports what to cut, move or rewrite and edits only after…
Make Landing
serejaris/personal-corp-os
Создаёт несколько вариантов дизайна 2D-поверхности (лендинг, герой, обложка, слайды): свой визуальный референс и автор на вариант, полный design.md с UTC/SHA-256 до кода, проверка в браузере…
Related
Categories
Questions about Readme Generator
What does Readme Generator do?
A skill your agent uses when creating or rewriting README.md for projects. Readme Generator is an agent skill from serejaris/personal-corp-os.md for projects.
When should I use Readme Generator?
Readme Generator fits situations like: rewriting README.md for projects; tasks that involve Technical documentation.
How do I install Readme Generator in Claude Code?
Run `npx skills add serejaris/personal-corp-os --skill readme-generator -a claude-code`. Or copy the skill folder (skills/readme-generator in serejaris/personal-corp-os) into .claude/skills/readme-generator in your project. Claude Code loads it when a task matches its description.
How do I install Readme Generator in Codex?
Run `npx skills add serejaris/personal-corp-os --skill readme-generator -a codex`. Or copy the skill folder (skills/readme-generator in serejaris/personal-corp-os) into .agents/skills/readme-generator in your project. Codex loads it when a task matches its description.
Can I use Readme Generator in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add serejaris/personal-corp-os --skill readme-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-generator, .gemini/skills/readme-generator, .github/skills/readme-generator and .opencode/skills/readme-generator in your project.
What does Readme Generator need to run?
SKILL.md names no scripts, command-line tools or credentials: Readme Generator is instructions for the agent only.
Does Readme Generator access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Readme Generator safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Readme Generator use?
Readme Generator is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Readme Generator use?
About 1.2k tokens (SKILL.md is roughly 4.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Readme Generator?
Skills that share tags, products or a category with Readme Generator: Diagram Design (cathrynlavery/diagram-design, 48k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Readme Generator?
serejaris (a GitHub user) maintains it in serejaris/personal-corp-os, which has 229 GitHub stars. The repository holds 36 skills in this directory. The repository was last updated on October 7, 2026.
Source: serejaris/personal-corp-os on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.