Skip to content

Commit e2f01c6

Browse files
authored
Merge pull request #37 from php-db/0.2.x
Merge README update into 0.3.x
2 parents 273c68c + 3eeb298 commit e2f01c6

1 file changed

Lines changed: 50 additions & 1 deletion

File tree

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
11
# phpdb-adapter-sqlite
22

3-
This package provides SQLite support for php-db.
3+
<!-- markdownlint-disable MD013 -->
4+
5+
This package provides [SQLite][sqlite] support for [php-db][php-db], which is a continuation of [laminas-db][laminas-db].
6+
7+
[![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)
8+
9+
## Prerequisites
10+
11+
You'll need the following to use the package:
12+
13+
- PHP 8.2 or above with the [PDO][php-pdo-extension] and [PDO SQLite][php-pdo-sqlite-extension] extensions
14+
- [Composer][composer] installed globally
15+
16+
## Quick Start
17+
18+
To get started with the project, add it to your project with the following command:
19+
20+
```bash
21+
composer require php-db/phpdb-sqlite
22+
```
23+
24+
## Contributing
25+
26+
Please be sure to read the [contributor's guide](https://github.com/php-db/.github/blob/main/CONTRIBUTING.md) for general information on contributing.
27+
This section outlines specifics for php-db.
28+
29+
### Test suites
30+
31+
To run the project's test suite, run the command below:
32+
33+
```bash
34+
composer check
35+
```
36+
37+
This [Composer script][composer-scripts] runs both the unit and integration tests, as well as code style and static analysis.
38+
39+
---
40+
41+
- File issues at <https://github.com/php-db/phpdb-sqlite/issues>
42+
- Documentation is at <https://docs.php-db.dev>
43+
44+
[composer]: https://getcomposer.org
45+
[composer-scripts]: https://getcomposer.org/doc/articles/scripts.md
46+
[laminas-db]: https://docs.laminas.dev/laminas-db/
47+
[php-db]: https://github.com/php-db/phpdb
48+
[php-pdo-extension]: https://www.php.net/manual/en/pdo.installation.php
49+
[php-pdo-sqlite-extension]: https://www.php.net/manual/en/ref.pdo-sqlite.php
50+
[sqlite]: https://sqlite.org/docs.html
51+
52+
<!-- markdownlint-enable MD013 -->

0 commit comments

Comments
 (0)