How do I install the Shared Readme skill?

Run npx skillmds@latest add tomevault-io/shared-readme in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Shared Readme safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Shared Readme?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Shared Readme free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Shared Readme?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Shared Readme by tomevault-io — Agent Skill

Name: Shared Readme
Author: tomevault-io

File contents

Purpose

Generate a well-structured README.md that helps users and contributors understand, set up, and use the project.

Arguments

--platform <p> — Target platform: mern or ios (auto-detected if not specified)
--minimal — Generate minimal README (overview + setup only)
--badges — Include status badges (CI, coverage, license)

README sections

Standard (all projects)

Title + Description — What is this project?
Features — Key capabilities
Prerequisites — Required tools and versions
Quick Start — Get running in 5 minutes
Development — Common commands
Project Structure — Directory overview
Contributing — How to contribute
License — Legal terms

Platform-specific

MERN additions:

Environment setup (.env)
API documentation link
Deployment instructions

iOS additions:

Xcode version requirement
Simulator/device setup
Code signing notes

Badges available

![CI](https://github.com/user/repo/workflows/CI/badge.svg)
![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
![License](https://img.shields.io/badge/license-MIT-blue.svg)

Workflow

Detect or specify platform
Scan project for structure
Extract info from package.json / Xcode project
Generate README sections
Add badges (if requested)
Write README.md

Best practices enforced

Clear, scannable structure
Copy-paste ready commands
Links to detailed documentation
No stale information (generated from project)

Output

README.md created/updated
Sections generated based on project

Reference

For templates and examples, see reference/shared-readme-reference.md

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: shared-readmedescription: Generate comprehensive README.md with project overview, setup instructions, and usage documentation. Use when this capability is needed.---## PurposeGenerate a well-structured README.md that helps users and contributors understand, set up, and use the project.## Arguments- `--platform <p>` — Target platform: `mern` or `ios` (auto-detected if not specified)- `--minimal` — Generate minimal README (overview + setup only)- `--badges` — Include status badges (CI, coverage, license)## README sections### Standard (all projects)1. **Title + Description** — What is this project?2. **Features** — Key capabilities3. **Prerequisites** — Required tools and versions4. **Quick Start** — Get running in 5 minutes5. **Development** — Common commands6. **Project Structure** — Directory overview7. **Contributing** — How to contribute8. **License** — Legal terms### Platform-specific**MERN additions:**- Environment setup (.env)- API documentation link- Deployment instructions**iOS additions:**- Xcode version requirement- Simulator/device setup- Code signing notes## Badges available```markdown![CI](https://github.com/user/repo/workflows/CI/badge.svg)![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)![License](https://img.shields.io/badge/license-MIT-blue.svg)```## Workflow1. Detect or specify platform2. Scan project for structure3. Extract info from package.json / Xcode project4. Generate README sections5. Add badges (if requested)6. Write README.md## Best practices enforced- Clear, scannable structure- Copy-paste ready commands- Links to detailed documentation- No stale information (generated from project)## Output- README.md created/updated- Sections generated based on project## ReferenceFor templates and examples, see `reference/shared-readme-reference.md`---> Converted and distributed by [TomeVault](https://tomevault.io/claim/edfenton) — claim your Tome and manage your conversions.

Frequently asked questions

Shared Readme