Maintain DisCatSharp
Aiko-IT-Systems/DisCatSharp
Guides changes to the DisCatSharp C# Discord library: tracing a payload field through parsing, serialization and caches, then validating across target frameworks.
Write or improve concise, reader-focused README.md files for open source projects.
Install Create Readme
$ npx skills add elithrar/dotfiles --skill create-readme -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install elithrar/dotfiles create-readme --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/elithrar/dotfiles.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/create-readme .claude/skills/create-readme && 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 "create-readme" agent skill from https://github.com/elithrar/dotfiles/tree/main/.agents/skills/create-readme into .claude/skills/create-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "create-readme", 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/elithrar/dotfiles/tree/main/.agents/skills/create-readmeType 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 elithrar/dotfiles --skill create-readme -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install elithrar/dotfiles create-readme --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elithrar/dotfiles.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/create-readme .agents/skills/create-readme && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "create-readme" agent skill from https://github.com/elithrar/dotfiles/tree/main/.agents/skills/create-readme into .agents/skills/create-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "create-readme", 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 elithrar/dotfiles --skill create-readme -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install elithrar/dotfiles create-readme --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elithrar/dotfiles.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/create-readme .cursor/skills/create-readme && 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 "create-readme" agent skill from https://github.com/elithrar/dotfiles/tree/main/.agents/skills/create-readme into .cursor/skills/create-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "create-readme", 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/elithrar/dotfiles.git --path .agents/skills/create-readme--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 elithrar/dotfiles --skill create-readme -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install elithrar/dotfiles create-readme --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elithrar/dotfiles.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/create-readme .gemini/skills/create-readme && 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 "create-readme" agent skill from https://github.com/elithrar/dotfiles/tree/main/.agents/skills/create-readme into .gemini/skills/create-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "create-readme", 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 elithrar/dotfiles create-readmeInstalls 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 elithrar/dotfiles --skill create-readme -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/elithrar/dotfiles.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/create-readme .github/skills/create-readme && 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 "create-readme" agent skill from https://github.com/elithrar/dotfiles/tree/main/.agents/skills/create-readme into .github/skills/create-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "create-readme", 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 elithrar/dotfiles --skill create-readme -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install elithrar/dotfiles create-readme --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elithrar/dotfiles.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/create-readme .opencode/skills/create-readme && 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 "create-readme" agent skill from https://github.com/elithrar/dotfiles/tree/main/.agents/skills/create-readme into .opencode/skills/create-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "create-readme", 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
create-readme- GitHub stars
- 202
- Token cost
- ~748 tokens
- SKILL.md length
- 349 words
- Files
- 1
- Skills in repo
- 12
- Repo updated
- First seen
- Licence
- MIT
At a glance
Write or improve concise, reader-focused README.md files for open source projects.
- Works in 5 steps: Inspect the existing README, manifests,… → Identify the intended reader, the… → Choose only the sections the project… → …
- README rewrites
- SKILL.md covers Workflow and House Style
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Create Readme is an agent skill from elithrar/dotfiles. Write or improve concise, reader-focused README.md files for open source projects. Use for new READMEs, README rewrites, installation and usage examples, or README reviews. Do not use for API references, tutorials, changelogs, contributing guides, or unrelated prose editing.
Its SKILL.md is about 750 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation, Changelog and release notes and Open source maintenance. The repository describes itself as: dotfiles for my macOS & Linux environments ⌨️. The licence is MIT.
When your agent uses it
- README rewrites
- Installation and usage examples
- Contributing guides
- Unrelated prose editing
Example prompts
- “/create-readme”
Workflow steps
5 steps, taken from the first numbered list in SKILL.md.
- Inspect the existing README, manifests, public APIs, examples, tests, release metadata, and license as relevant.
- Identify the intended reader, the problem the project solves, its shortest useful workflow, and any adoption-critical limits or tradeoffs.
- Choose only the sections the project needs. A typical order is: project name, direct introduction, key capabilities, installation, a…
- Write the smallest realistic example first. Use actual commands, package names, APIs, and configuration from the repository. Add…
- Verify changeable claims, commands, links, supported versions, and examples. Run the smallest safe example or relevant check when…
What it can do on your machine
Read from SKILL.md and the folder at commit 26e8a4b. 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.
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
github.com
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
Create Readme loads about 748 tokens when it runs. Until then it costs about 72 tokens; SKILL.md has 349 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 elithrar/dotfiles at commit 26e8a4b, republished under its MIT licence (© elithrar). 349 words, ~748 tokens.
Download SKILL.mdSave it as
.claude/skills/create-readme/SKILL.md (or your agent's skills folder).- name
- create-readme
- description
- Write or improve concise, reader-focused README.md files for open source projects. Use for new READMEs, README rewrites, installation and usage examples, or README reviews. Do not use for API references, tutorials, changelogs, contributing guides, or unrelated prose editing.
Create README
Write a README that tells prospective users what the project does, why it is useful, and how to reach a working result.
Workflow
- Inspect the existing README, manifests, public APIs, examples, tests, release metadata, and license as relevant.
- Identify the intended reader, the problem the project solves, its shortest useful workflow, and any adoption-critical limits or tradeoffs.
- Choose only the sections the project needs. A typical order is: project name, direct introduction, key capabilities, installation, a minimal example, advanced workflows or design notes, contributing, and license.
- Write the smallest realistic example first. Use actual commands, package names, APIs, and configuration from the repository. Add specialized examples only when they answer a likely next question.
- Verify changeable claims, commands, links, supported versions, and examples. Run the smallest safe example or relevant check when feasible, and report anything that remains unverified.
House Style
Use the house-style principles below. Consult these examples only when a requested style match needs more context: elithrar/ask-bonk, elithrar/simple-scrypt, elithrar/fuse-on-r2, and especially gorilla/csrf.
- Explain usefulness before setup. Name concrete outcomes and use cases instead of calling the project powerful, robust, or easy.
- Move quickly from context to installation and a working example.
- Introduce examples with what they demonstrate. Progress from the common case to meaningful variants.
- Put security warnings, operational caveats, and tradeoffs beside the example or claim they qualify.
- Use design notes when they help readers trust an important implementation choice.
- Keep the structure proportional to the project. A demo may need only context, tradeoffs, deployment, and links. A mature library may need compatibility, several examples, and design rationale.
- Use concise, direct American English with a conversational technical tone. Keep mild personality when it is natural.
- Preserve the author's terminology and voice. Avoid marketing language, filler, repetition, and sections added only by convention.
Never invent features, commands, support, performance, or maturity. If the project's purpose or audience cannot be established from available evidence, ask one focused question.
For an audit-only request, report prioritized findings without editing. For a create, rewrite, or fix request, update the README and preserve unrelated files.
© elithrar, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/create-readme of elithrar/dotfiles.
Open the folder on GitHubat commit 26e8a4b
Compare with similar skills
Create Readme 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 |
|---|---|---|---|---|---|---|
| Create Readme this skillelithrar/dotfiles | 202 | — | ~748 | Automated safety check: Pass | MIT | |
| Maintain DisCatSharpAiko-IT-Systems/DisCatSharp | 140 | — | ~1.2k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Mole Release Notes Publishertw93/Mole | 70k | — | ~1.9k | Automated safety check: Pass | GPL-3.0 | |
| Ccb GitHubSeemSeam/claude_codex_bridge | 3.6k | — | ~4.9k | Automated safety check: Pass | Custom licence | |
| Golang Documentationunxed/f4 | 241 | 3 repos | ~3.5k | Automated safety check: Pass | 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.
Mole Release Notes Publisher
tw93/Mole
Publishes curated, bilingual release notes for an existing Mole version tag with gh release edit, including contributor thanks and reactions, after the release workflow finishes.
Ccb GitHub
SeemSeam/claude_codex_bridge
Maintain this CCB project's GitHub-facing release and npm publication surface.
Golang Documentation
unxed/f4
Comprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt.
Simple English
ropensci/ckanr
Write or rewrite text in plain, layman-readable English in the spirit of ASD-STE100 Simplified Technical English: short sentences, active voice, simple tenses, one word one meaning, condition before…
More from elithrar/dotfiles
All 12 skills in this repoPrompt Engineer
elithrar/dotfiles
Audit and revise system prompts, developer instructions, tool descriptions, and reusable LLM prompt templates.
Code Reviewer
elithrar/dotfiles
Review a specified code change for actionable defects. An agent skill from elithrar/dotfiles.
Cut Ready
elithrar/dotfiles
Prepare or review CAD and vector artwork for physical fabrication, cutting, printing, or machining.
Logging Sucks
elithrar/dotfiles
Design or review structured application logging, canonical request events, correlation, redaction, and sampling.
Motronic
elithrar/dotfiles
Diagnose Porsche Carrera 3.2 Bosch Motronic faults and interpret DME ROMs or calibration changes.
Neo Industrial Design
elithrar/dotfiles
Design or restyle web interfaces in the user's neo-industrial or editorial-brutalist style.
Related
Categories
Questions about Create Readme
What does Create Readme do?
Write or improve concise, reader-focused README.md files for open source projects. Create Readme is an agent skill from elithrar/dotfiles.md files for open source projects.
When should I use Create Readme?
Create Readme fits situations like: README rewrites; installation and usage examples; contributing guides; unrelated prose editing.
How do I install Create Readme in Claude Code?
Run `npx skills add elithrar/dotfiles --skill create-readme -a claude-code`. Or copy the skill folder (.agents/skills/create-readme in elithrar/dotfiles) into .claude/skills/create-readme in your project. Claude Code loads it when a task matches its description.
How do I install Create Readme in Codex?
Run `npx skills add elithrar/dotfiles --skill create-readme -a codex`. Or copy the skill folder (.agents/skills/create-readme in elithrar/dotfiles) into .agents/skills/create-readme in your project. Codex loads it when a task matches its description.
Can I use Create Readme 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 elithrar/dotfiles --skill create-readme -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/create-readme, .gemini/skills/create-readme, .github/skills/create-readme and .opencode/skills/create-readme in your project.
What does Create Readme need to run?
SKILL.md names no scripts, command-line tools or credentials: Create Readme is instructions for the agent only.
Does Create Readme access the network?
SKILL.md names 1 domain. As links in the text: github.com. This is read from the text; nothing was executed.
Is Create Readme 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 Create Readme use?
Create Readme 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 Create Readme use?
About 748 tokens (SKILL.md is roughly 3k 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 Create Readme?
Skills that share tags, products or a category with Create Readme: Maintain DisCatSharp (Aiko-IT-Systems/DisCatSharp, 140 stars), Simple English (moeru-ai/airi, 50k stars), Mole Release Notes Publisher (tw93/Mole, 70k stars) and Ccb GitHub (SeemSeam/claude_codex_bridge, 3.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Create Readme?
elithrar (a GitHub user) maintains it in elithrar/dotfiles, which has 202 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on October 7, 2026.
Source: elithrar/dotfiles on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.