diff --git a/README.md b/README.md index 42b77d8..1b950f2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,52 @@ # 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 + +To run the project's test suite, run the command below: + +```bash +composer check +``` + +This [Composer script][composer-scripts] runs both the unit and integration tests, as well as code style and static analysis. + +--- + +- File issues at +- 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 +[php-pdo-sqlite-extension]: https://www.php.net/manual/en/ref.pdo-sqlite.php +[sqlite]: https://sqlite.org/docs.html + +