readme-generator skillA
readme-generator is agent-read markdown (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..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
# 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
```dot
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:
```
…Read the whole file at its exact version.
How to install
mdr add serejaris/personal-corp-os/readme-generator@git:20260111.6993e7amdr add serejaris/personal-corp-os/readme-generator@sha256:198a04d31d6ba1c7Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_vc3lqntfbnjhjkgl)
1 badge views in 30 days
Versions
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (4843 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
serejaris/personal-corp-os · 228 stars · license MIT · pushed 2026-09-17 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_vc3lqntfbnjhjkgl GET https://markdownregistry.com/api/v1/resolve?ref=serejaris/personal-corp-os/readme-generator GET https://markdownregistry.com/api/v1/blob/198a04d31d6ba1c799bc1fa1995f5367cde892011e6496113feedd7f83ce50eb
Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.