Skip to content

docs: put the composer install line first in the README - #33

Merged
karlwaldman merged 1 commit into
mainfrom
docs/install-first
Oct 14, 2026
Merged

karlwaldman merged 1 commit into
mainfrom
docs/install-first

Conversation

@karlwaldman

Copy link
Copy Markdown
Member

Moves the existing ## Install block (composer require oilpriceapi/oilpriceapi) from line 26 to directly under the badges, above Requirements. The Packagist version badge is already at the top (line 6), so no badge change.

Context: Packagist reports 16 total, 0 monthly downloads (curl -s https://packagist.org/packages/oilpriceapi/oilpriceapi.json, 2026-10-14).

Verification: vendor/bin/phpunit -> OK (248 tests, 766 assertions), including PublicClaimsTest which reads README.md.

Expected effect: the install command is the first thing a PHP developer sees on GitHub and Packagist (which renders this README).

🤖 Generated with Claude Code

https://claude.ai/code/session_01QQ7W3CkRKEnBpU5KRQUfUu

@coderabbitai

coderabbitai Bot commented Oct 14, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 5852d4bb-50f6-46c4-ade4-42bfb6ffbec9
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@karlwaldman karlwaldman added the risk:elevated Elevated: auto-merges after an adversarial review APPROVE label Oct 14, 2026
@karlwaldman

Copy link
Copy Markdown
Member Author

Adversarial review: APPROVE (head e85d0ef)

The README-only change moves ## Install above ## Requirements. The text is unchanged.

Tried to refute:

  • Is the install line wrong? Refuted. composer.json name is oilpriceapi/oilpriceapi. https://repo.packagist.org/p2/oilpriceapi/oilpriceapi.json returns 200 with versions v3.0.1, v3.0.0, v2.1.2, so composer require oilpriceapi/oilpriceapi resolves.
  • Does any test assert README section order? No; nothing in tests/ references the headings.

CI: green on PHP 8.1–8.5, PHPStan level 9 and the packaged Composer example. The live first request is skipped, as on other fork-less PRs.

@karlwaldman
karlwaldman merged commit e552baa into main Oct 14, 2026
9 checks passed
@karlwaldman
karlwaldman deleted the docs/install-first branch October 14, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk:elevated Elevated: auto-merges after an adversarial review APPROVE

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant