Refresh README for current functionality #15
Conversation
|
@codex review |
There was a problem hiding this comment.
Pull request overview
This PR refreshes the README documentation to reflect current functionality and improve clarity. The changes include updating system requirements (PHP 8.3+, database driver support), adding the phpstan command for static analysis, clarifying nullable return values for getById() and fetchOneWhere(), and fixing various typos throughout.
Changes:
- Updated requirements section to specify PHP 8.3+ and clarify database driver support (MySQL/MariaDB, PostgreSQL tested; SQLite supported but not tested)
- Added phpstan static analysis command to testing section
- Clarified nullable behavior:
getById()andfetchOneWhere()return null when no records are found - Fixed multiple typos: "Catgory" → "Category", "categoies" → "categories", "Arbitary" → "Arbitrary"
- Improved code formatting with proper markdown code blocks and consistent spacing in examples
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cbb584322b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| } | ||
| * PHP >= 8.3 | ||
| * PDO with MySQL/MariaDB or PostgreSQL drivers | ||
| * SQLite is supported in code paths but not covered by tests |
There was a problem hiding this comment.
The README now states SQLite is supported, but Model::insert() builds INSERT INTO ... SET ... for all non-PostgreSQL drivers; that syntax is MySQL-specific and will fail on SQLite as soon as you insert a row with any column values. This means users trying SQLite will hit SQL errors during normal inserts, so the documentation is misleading unless the insert path is updated to use SQLite-compatible syntax.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
To use Codex here, create an environment for this repo.
davebarnwell
force-pushed
the
docs/refresh-readme
branch
from
411a4ca to
a2e83ed
Compare
Summary
Testing