Skip to content

docs: refresh the README - #3

Merged
ogorzalka merged 2 commits into
mainfrom
docs/readme-refresh
Oct 7, 2026
Merged

ogorzalka merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@ogorzalka

Copy link
Copy Markdown
Member

Restructures the README on the shared Pollora layout.

  • Banner header with version, downloads, Tests and license badges; intro paragraph and a "Part of Pollora" line (Pollora\Support\Facades\PostQuery).
  • New Installation (PHP 8.2+, WordPress) and Quick start with three queries built from the test suite.
  • The method documentation is kept, under ## Reference with ### sections and a one-line table of contents.
  • Fixes: the default post_type is 'any' (the README said 'all' in 43 examples), created()/modified() described correctly, latest()/oldest()/inRandomOrder() documented, missing imports added to the complete example.
  • Testing, Contributing and License footer; LICENSE holder line now links https://rubee.group.

@ogorzalka
ogorzalka merged commit bd12739 into main Oct 7, 2026
2 checks passed
@ogorzalka
ogorzalka deleted the docs/readme-refresh branch October 7, 2026 08:37
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