Skip to content

docs(repo): shorten README, add logo, use AGENTS.md - #2

Merged
mrcsin merged 1 commit into
masterfrom
readme-logo
Oct 1, 2026
Merged

mrcsin merged 1 commit into
masterfrom
readme-logo

Conversation

@mrcsin

@mrcsin mrcsin commented Oct 1, 2026

Copy link
Copy Markdown
Owner

README carried build, release and validation details an operator does not need.

  • README keeps the API, host requirements, configuration and the socket access model, and shows the new logo
  • Build arguments move to AGENTS.md
  • CLAUDE.md is renamed to AGENTS.md; Claude Code 2.1.277+ reads it when no CLAUDE.md is on the path. The three comments that named CLAUDE.md now name AGENTS.md

Verified: git grep CLAUDE finds nothing; the logo renders on light and dark backgrounds.

README keeps the operator facts; build arguments move to AGENTS.md.
Claude Code reads AGENTS.md when no CLAUDE.md is on the path.
@mrcsin
mrcsin merged commit 1673bcf into master Oct 1, 2026
2 checks passed
@mrcsin
mrcsin deleted the readme-logo branch October 1, 2026 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant