1panel App Builder
arch3rPro/1Panel-Appstore
A skill your agent uses when packaging Docker deployments as 1Panel local app store apps, including GitHub projects, docker-compose.yml files, docker run commands, app metadata, version directories…
When the user wants to create or update a README.md file for a project.
Install Readme
$ npx skills add aiskillstore/marketplace --skill readme -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install aiskillstore/marketplace 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/aiskillstore/marketplace.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/sickn33/readme .claude/skills/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 "readme" agent skill from https://github.com/aiskillstore/marketplace/tree/main/skills/sickn33/readme into .claude/skills/readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "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/aiskillstore/marketplace/tree/main/skills/sickn33/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 aiskillstore/marketplace --skill readme -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install aiskillstore/marketplace readme --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/aiskillstore/marketplace.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/sickn33/readme .agents/skills/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 "readme" agent skill from https://github.com/aiskillstore/marketplace/tree/main/skills/sickn33/readme into .agents/skills/readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "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 aiskillstore/marketplace --skill readme -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install aiskillstore/marketplace readme --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/aiskillstore/marketplace.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/sickn33/readme .cursor/skills/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 "readme" agent skill from https://github.com/aiskillstore/marketplace/tree/main/skills/sickn33/readme into .cursor/skills/readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "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/aiskillstore/marketplace.git --path skills/sickn33/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 aiskillstore/marketplace --skill readme -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install aiskillstore/marketplace readme --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/aiskillstore/marketplace.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/sickn33/readme .gemini/skills/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 "readme" agent skill from https://github.com/aiskillstore/marketplace/tree/main/skills/sickn33/readme into .gemini/skills/readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "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 aiskillstore/marketplace 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 aiskillstore/marketplace --skill readme -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/aiskillstore/marketplace.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/sickn33/readme .github/skills/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 "readme" agent skill from https://github.com/aiskillstore/marketplace/tree/main/skills/sickn33/readme into .github/skills/readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "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 aiskillstore/marketplace --skill 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 aiskillstore/marketplace readme --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/aiskillstore/marketplace.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/sickn33/readme .opencode/skills/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 "readme" agent skill from https://github.com/aiskillstore/marketplace/tree/main/skills/sickn33/readme into .opencode/skills/readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "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
readme- GitHub stars
- 430
- Used in
- 5 other repos
- Token cost
- ~4.9k tokens
- SKILL.md length
- 620 words
- Files
- 2
- Skills in repo
- 1,085
- Repo updated
- First seen
- Licence
- None found
At a glance
When the user wants to create or update a README.md file for a project.
- Works in 12 steps: Deep Codebase Exploration → Identify Deployment Target → Ask Only If Critical → …
- Wants to create
- SKILL.md covers When to Use This Skill, The Three Purposes of a README, Before Writing and README Structure, plus 2 more sections
- Reaches github.com; needs RAILS_MASTER_KEY and POSTGRES_PASSWORD
What it does
Readme is an agent skill from aiskillstore/marketplace. When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.
Its SKILL.md is about 4.9k tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file (for example `skill-report.json`).
It sits in Development, covering Technical documentation and Deployment. It works with Docker and Ruby. The repository describes itself as: Security-audited skills for Claude, Codex & Claude Code. One-click install, quality verified.
When your agent uses it
- Wants to create
- Update a README.md file for a project
- The user says write readme
- Document this project
Example prompts
- “write readme,”
- “create readme,”
- “document this project,”
- “/readme”
Requirements
- Node.js
- Docker
- A credential in RAILS_MASTER_KEY
Workflow steps
12 steps, taken from the step headings in SKILL.md.
- Deep Codebase Exploration
- Identify Deployment Target
- Ask Only If Critical
- Project Title and Overview
- Tech Stack
- Prerequisites
- Getting Started
- Architecture Overview
- Environment Variables
- Available Scripts
- Testing
- Deployment
What it can do on your machine
Read from SKILL.md and the folder at commit 4ac52da. 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).
From the folder's file list and the shell code blocks in SKILL.md.
Network
Hosts in commands or code, which the agent is likely to contact:
github.com
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names these keys or tokens, usually read from environment variables:
RAILS_MASTER_KEYPOSTGRES_PASSWORD
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Readme loads about 4.9k tokens when it runs. Until then it costs about 81 tokens; SKILL.md has 620 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: notes
The automated check noted patterns worth knowing about, such as sudo or a known installer.
- NoteMentions a .env fileSKILL.md:183
cp .env.example .env - NoteRuns commands with sudoSKILL.md:702
sudo systemctl restart myapp - NoteRuns commands with sudoSKILL.md:758
sudo apt-get install libpq-dev
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
Without a licence we can't republish the file, so here is its outline and opening line. It has 620 words (~4,888 tokens).
“You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.”
- name
- readme
- source
- https://github.com/Shpigford/skills/tree/main/readme
- risk
- safe
Files
SKILL.md and 1 other file in skills/sickn33/readme of aiskillstore/marketplace.
- SKILL.md
- skill-report.json
Open the folder on GitHubat commit 4ac52da
Used in 5 other repositories
We found 14 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 5 other GitHub owners. This page covers the copy in aiskillstore/marketplace, which our catalogue first saw on October 7, 2026.
- sickn33/agentic-awesome-skillsskills/readmeplugins/agentic-awesome-skills/skills/readme+1 more
- agent-skills-hub/agent-skills-hubskills/readme
- lingxling/awesome-skills-cnantigravity-awesome-skills/skills/readmeantigravity-awesome-skills/plugins/agentic-awesome-skills/skills/readme+1 more
- benjaminasterA/antigravity-awesome-skillsskills/readme
- henryalouf/ruflow.agents/skills/readme.agents/skills/antigravity-awesome-skills/skills/readme+4 more
Compare with similar skills
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 |
|---|---|---|---|---|---|---|
| Readme this skillaiskillstore/marketplace | 430 | 5 repos | ~4.9k | Automated safety check: Notes | None | |
| 1panel App Builderarch3rPro/1Panel-Appstore | 213 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Verify New Sample PRpnp/sp-dev-fx-aces | 139 | — | ~2k | Automated safety check: Pass | MIT | |
| Sync Dependabot Pinsossf/oss-crs | 165 | — | ~1.7k | Automated safety check: Notes | MIT | |
| Kouchou AI Developmentdigitaldemocracy2030/kouchou-ai | 171 | — | ~540 | Automated safety check: Notes | AGPL-3.0 | |
| Flowfile Config and Flags CatalogEdwardvaneechoud/Flowfile | 370 | — | ~12k | Automated safety check: Notes | MIT |
Similar skills
Verify New Sample PR
pnp/sp-dev-fx-aces
Verify a "new sample" PR in pnp/sp-dev-fx-aces builds successfully, then produce a deployment + testing checklist from the sample README so it can be manually deployed and tested before merging.
Sync Dependabot Pins
ossf/oss-crs
After a Dependabot bump of oss-crs-infra/dependabot-pins.Dockerfile, resolve the human-readable version tag for each updated digest, fix the inline comment, and sync the digest to…
Kouchou AI Development
digitaldemocracy2030/kouchou-ai
Local development setup, build and lint commands, environment configuration, and deployment helpers for the kouchou-ai repo.
Flowfile Config and Flags Catalog
Edwardvaneechoud/Flowfile
Catalog of Flowfile's environment variables and runtime flags: what each does, where the code reads it, its default, and where the docs disagree with the code.
Genie API Service Docs
qualcomm/qai-appbuilder
GenieAPIService technical documentation retrieval. An agent skill from qualcomm/qai-appbuilder.
More from aiskillstore/marketplace
All 1,085 skills in this repoCode Stats
aiskillstore/marketplace
Analyze codebase with tokei (fast line counts by language) and difft (semantic AST-aware diffs).
Data Processing
aiskillstore/marketplace
Process JSON with jq and YAML/TOML with yq. An agent skill from aiskillstore/marketplace.
Doc Scanner
aiskillstore/marketplace
Scans for project documentation files (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and 15+ other formats) and synthesizes guidance.
File Search
aiskillstore/marketplace
Modern file and content search using fd, ripgrep (rg), and fzf.
Find Replace
aiskillstore/marketplace
Modern find-and-replace using sd (simpler than sed) and batch replacement patterns.
Investigating Codebases
aiskillstore/marketplace
Automatically activated when user asks how something works, wants to understand unfamiliar code, needs to explore a new codebase, or asks questions like "where is X implemented?", "how does Y…
Related
Categories
Questions about Readme
What does Readme do?
When the user wants to create or update a README.md file for a project. Readme is an agent skill from aiskillstore/marketplace.md file for a project.
When should I use Readme?
Readme fits situations like: wants to create; update a README.md file for a project; the user says write readme; document this project.
How do I install Readme in Claude Code?
Run `npx skills add aiskillstore/marketplace --skill readme -a claude-code`. Or copy the skill folder (skills/sickn33/readme in aiskillstore/marketplace) into .claude/skills/readme in your project. Claude Code loads it when a task matches its description.
How do I install Readme in Codex?
Run `npx skills add aiskillstore/marketplace --skill readme -a codex`. Or copy the skill folder (skills/sickn33/readme in aiskillstore/marketplace) into .agents/skills/readme in your project. Codex loads it when a task matches its description.
Can I use 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 aiskillstore/marketplace --skill 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/readme, .gemini/skills/readme, .github/skills/readme and .opencode/skills/readme in your project.
What does Readme need to run?
Going by SKILL.md and its folder, Readme needs credentials named RAILS_MASTER_KEY and POSTGRES_PASSWORD. Our summary lists: Node.js; Docker; A credential in RAILS_MASTER_KEY.
Does Readme access the network?
SKILL.md names 1 domain. In commands or code: github.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.
Is Readme safe to install?
Our automated static check of SKILL.md found notes only (mentions a .env file; runs commands with sudo), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.
What licence does Readme use?
No licence was found for Readme or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.
How many tokens does Readme use?
About 4.9k tokens (SKILL.md is roughly 20k 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?
Skills that share tags, products or a category with Readme: 1panel App Builder (arch3rPro/1Panel-Appstore, 213 stars), Verify New Sample PR (pnp/sp-dev-fx-aces, 139 stars), Sync Dependabot Pins (ossf/oss-crs, 165 stars) and Kouchou AI Development (digitaldemocracy2030/kouchou-ai, 171 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Readme?
aiskillstore (a GitHub organization) maintains it in aiskillstore/marketplace, which has 430 GitHub stars. The repository holds 1,085 skills in this directory. The repository was last updated on October 7, 2026.
Source: aiskillstore/marketplace on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.