Skip to content

docs: badges, live docs link, install instructions#11

Merged
attitude merged 1 commit into
mainfrom
docs/readme-adoption
Jul 7, 2026
Merged

docs: badges, live docs link, install instructions#11
attitude merged 1 commit into
mainfrom
docs/readme-adoption

Conversation

@attitude

@attitude attitude commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add CI/Docs/PHP-version/License badges under the README tagline for at-a-glance project health and discoverability.
  • Replace the vague "live at the docs site" sentence with a direct link to https://attitude.github.io/phpx-server/, keeping the pointer to docs/ sources.
  • Add an "Install in your project" section to README.md and a mirrored "Use it in your project" section to docs/docs/getting-started.md, spelling out the non-obvious Composer gotcha: since neither attitude/phpx-server nor attitude/phpx is on Packagist yet, and Composer only reads repositories (and dev-stability requires) from the root composer.json, consumers must declare both VCS repositories and both requires themselves — phpx-server's own repository declaration for phpx doesn't propagate to consumers.

Why

These are adoption blockers: without the install snippet, a first-time consumer hits an unresolvable dependency error with no obvious fix. Badges and a working docs link improve first-impression discoverability.

Test plan

  • Verified badge URLs point to existing workflow files (.github/workflows/ci.yml, docs.yml)
  • Verified composer.json snippet matches the actual repo/dependency structure (phpx-server requires attitude/phpx dev-main, declares its own VCS repo)
  • Rendered both markdown files locally to confirm formatting

🤖 Generated with Claude Code

@attitude attitude merged commit fbaa785 into main Jul 7, 2026
3 checks passed
@attitude attitude deleted the docs/readme-adoption branch July 7, 2026 00:10
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