From 26db5783853938ac3590e1376d45ac9da87624e2 Mon Sep 17 00:00:00 2001 From: Matthew Setter Date: Wed, 8 Apr 2026 22:08:06 +1000 Subject: [PATCH 1/2] Update the project's README This change fleshes out the README, providing the bare essentials for the README to help users get up and running with the project, and, hopefully, contributing to it as well. Signed-off-by: Matthew Setter --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 42b77d8..1e1b08b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,53 @@ # phpdb-adapter-sqlite -This package provides SQLite support for php-db. + + +This package provides [SQLite][sqlite] support for [php-db][php-db], which is a continuation of [laminas-db][laminas-db]. + +[![Build Status](https://github.com/php-db/phpdb-sqlite/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/php-db/phpdb-sqlite/actions/workflows/continuous-integration.yml) + +## Prerequisites + +You'll need the following to use the package: + +- PHP 8.2 or above with the [PDO][php-pdo-extension] and [PDO SQLite][php-pdo-sqlite-extension] extensions +- [Composer][composer] installed globally + +## Quick Start + +To get started with the project, add it to your project with the following command: + +```bash +composer require php-db/phpdb-sqlite +``` + +## Contributing + +Please be sure to read the [contributor's guide](https://github.com/php-db/.github/blob/main/CONTRIBUTING.md) for general information on contributing. +This section outlines specifics for php-db. + +### Test suites + +The `phpunit.xml.dist` file defines two test suites, "unit test" and "integration test". +You can run one or the other using the `--testsuite` option to `phpunit`: + +```bash +./vendor/bin/phpunit --testsuite "unit test" # unit tests only +./vendor/bin/phpunit --testsuite "integration test" # integration tests only +``` + +Unit tests do not require additional functionality beyond having the appropriate database extensions present and loaded in your PHP binary. + +--- + +- File issues at +- Documentation is at + +[composer]: https://getcomposer.org +[laminas-db]: https://docs.laminas.dev/laminas-db/ +[php-db]: https://github.com/php-db/phpdb +[php-pdo-extension]: https://www.php.net/manual/en/pdo.installation.php +[php-pdo-sqlite-extension]: https://www.php.net/manual/en/ref.pdo-sqlite.php +[sqlite]: https://sqlite.org/docs.html + + From 16852d5fea8efb7ed3366f795c92c868e71b9d7d Mon Sep 17 00:00:00 2001 From: Matthew Setter Date: Wed, 8 Apr 2026 22:16:29 +1000 Subject: [PATCH 2/2] Update the README's test suites section Signed-off-by: Matthew Setter This change replaces the Test suites section copied over from phpdb's README in the previous commit with one that is applicable to this project, specifically. --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1e1b08b..1b950f2 100644 --- a/README.md +++ b/README.md @@ -28,15 +28,13 @@ This section outlines specifics for php-db. ### Test suites -The `phpunit.xml.dist` file defines two test suites, "unit test" and "integration test". -You can run one or the other using the `--testsuite` option to `phpunit`: +To run the project's test suite, run the command below: ```bash -./vendor/bin/phpunit --testsuite "unit test" # unit tests only -./vendor/bin/phpunit --testsuite "integration test" # integration tests only +composer check ``` -Unit tests do not require additional functionality beyond having the appropriate database extensions present and loaded in your PHP binary. +This [Composer script][composer-scripts] runs both the unit and integration tests, as well as code style and static analysis. --- @@ -44,6 +42,7 @@ Unit tests do not require additional functionality beyond having the appropriate - Documentation is at [composer]: https://getcomposer.org +[composer-scripts]: https://getcomposer.org/doc/articles/scripts.md [laminas-db]: https://docs.laminas.dev/laminas-db/ [php-db]: https://github.com/php-db/phpdb [php-pdo-extension]: https://www.php.net/manual/en/pdo.installation.php