AgentStack
Browse Sign in
Browse Why AgentStack Sell Docs
Sign in
SKILL verified MIT Self-run

Readme First Builder

skill-endearqb-endearqb-skills-readme-first-builder · by endearqb

Initialize or upgrade a project to the full README First architecture from endearqb/ReadmeFirst. Use only when the user asks to initialize README First, install the README First framework, create the complete AGENTS.md + README.md + .ai/changes + .ai/decisions structure, or retrofit a repository with the README First architecture. After initialization, normal project work should follow the target…

↗ Repository
— No reviews yet
0 installs
10 views
0.0% view→install

Install

$ agentstack add skill-endearqb-endearqb-skills-readme-first-builder

✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.

Security review

✓ Passed

No issues found. Passed automated security review. · v0.1.0 How review works →

  • ✓ Prompt-injection patterns
  • ✓ Secret / credential exfiltration
  • ✓ Dangerous shell & filesystem operations
  • ✓ Untrusted network calls
  • ✓ Known-malicious package signatures

What it can access

  • ✓ Network access No
  • ✓ Filesystem access No
  • ✓ Shell / process execution No
  • ✓ Environment & secrets No
  • ✓ Dynamic code execution No

From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.

View the full security report →

Verified badge

Passed review? Show it. Paste this badge into your README, it links to the public security report.

AgentStack Verified badge Links to your public security report.
[![AgentStack Verified](https://agentstack.voostack.com/badges/verified.svg)](https://agentstack.voostack.com/security/report/skill-endearqb-endearqb-skills-readme-first-builder)

Reliability & compatibility

✓ Security review passed
0 installs to date
— no reviews yet
● 1mo ago

Declared compatibility

Claude CodeClaude Desktop

Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.

Preview Execution monitoring

We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.

How agent discovery & health will work →
Are you the author of Readme First Builder? Claim this listing to set pricing, connect Stripe payouts, and keep 70% of every sale.
Sign up to claim

About

README First Builder

Purpose

Use this skill as a one-time initializer or upgrader for a project-level README First architecture. Do not use it as the default way to write every README after a project already has AGENTS.md; once initialized, the target project's own AGENTS.md becomes the operating protocol.

Canonical Source

Read references/readmefirst-source.md for the upstream repository and file roles. The canonical project is endearqb/ReadmeFirst:

  • README.md: principle and architecture explanation.
  • AGENTS.md: executable agent protocol.

When network access is available, inspect the latest upstream files before initializing. If network is unavailable, explain that the initialization is based on the locally known structure and recommend a later sync.

Initialization Workflow

  1. Inspect the target project root and confirm whether AGENTS.md, README.md, and .ai/ already exist.
  2. If AGENTS.md is missing, create it from the upstream ReadmeFirst AGENTS.md content, then adapt only project-specific placeholders if necessary.
  3. If AGENTS.md already exists, merge the README First protocol into it without overwriting local rules. Keep stricter or project-specific local rules.
  4. Ensure the root README.md acts as the project map: purpose, setup, commands, top-level directory responsibilities, and links to important directory READMEs.
  5. Create .ai/changes/ and .ai/decisions/ if missing. Add lightweight starter templates only when useful.
  6. Add or update directory-level README.md files only for key long-lived directories. Do not cover generated, dependency, cache, build, log, or temporary directories.
  7. Record the initialization in .ai/changes/YYYY-MM-DD.md.
  8. Verify paths and commands mentioned in the generated docs.

Existing File Rules

  • Never overwrite an existing AGENTS.md or README.md blindly.
  • Treat existing project rules as local authority unless they conflict with safety or the user's explicit request.
  • Preserve user-authored prose and append or merge README First sections.
  • If the upstream AGENTS.md conflicts with existing project instructions, report the conflict and choose the least destructive merge.

Handoff After Initialization

End by telling future agents to follow the newly created or merged project AGENTS.md. For later ordinary code, documentation, review, or refactor tasks, use the project's own AGENTS.md and relevant directory READMEs rather than re-triggering this skill.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

Install and usage instructions live in the source repository linked above.

Reviews

No reviews yet, be the first.

Write a review

Versions

  • v0.1.0 Imported from the upstream source.

More in Agent Skills