From f7279e8aa62cbdfac296522e0f357aee67ad825e Mon Sep 17 00:00:00 2001
From: JonLee <leeqvip@gmail.com>
Date: Sun, 30 Aug 2026 00:34:44 +0800
Subject: [PATCH] docs: expand README with requirements, config reference and
 API details

---
 README.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 112 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7a93c9b..0cebce4 100644
--- a/README.md
+++ b/README.md
@@ -6,16 +6,22 @@
 [![Total Downloads](https://poser.pugx.org/leeqvip/database/downloads)](https://packagist.org/packages/leeqvip/database)
 [![License](https://poser.pugx.org/leeqvip/database/license)](https://packagist.org/packages/leeqvip/database)
 
-PDO database library for PHP.
+A lightweight PDO database library for PHP.
 
-the current supported databases are:
+The currently supported databases are:
 
-| type | database |
-| ------ | ------ |
-| mysql | MySQL |
-| pgsql | PostgreSQL |
-| sqlite | SQLite |
-| sqlsrv | SqlServer |
+| type | database | PDO driver |
+| ------ | ------ | ------ |
+| mysql | MySQL | `pdo_mysql` |
+| pgsql | PostgreSQL | `pdo_pgsql` |
+| sqlite | SQLite | `pdo_sqlite` |
+| sqlsrv | SQL Server | `pdo_sqlsrv` |
+
+### Requirements
+
+- PHP >= 8.0
+- [ext-pdo](https://www.php.net/manual/en/book.pdo.php)
+- The PDO driver for your database, e.g. `pdo_mysql`, `pdo_pgsql` or `pdo_sqlite`. For SQL Server, install the [pdo_sqlsrv](https://learn.microsoft.com/en-us/sql/connect/php/installing-the-microsoft-drivers-for-php-for-sql-server) extension (not bundled with PHP).
 
 ### Installation
 
@@ -27,28 +33,121 @@ composer require leeqvip/database
 
 ### Usage
 
+#### Quick start
+
 ```php
 require_once './vendor/autoload.php';
 
 use Leeqvip\Database\Manager;
 
 $config = [
-    'type'     => 'mysql', // mysql,pgsql,sqlite,sqlsrv
+    'type'     => 'mysql', // mysql, pgsql, sqlite, sqlsrv
     'hostname' => '127.0.0.1',
     'database' => 'test',
     'username' => 'root',
     'password' => 'abc-123',
     'hostport' => '3306',
+    'charset'  => 'utf8mb4',
 ];
 
 $manager = new Manager($config);
-$connection = $manager->getConnection();
+$connection = $manager->getConnection(); // lazily creates and caches one Connection
+
+// Returns all matching rows as an array of associative arrays
+$rows = $connection->query('SELECT * FROM `users` WHERE `id` = :id', ['id' => 1]);
+
+// Returns the number of affected rows
+$count = $connection->execute(
+    'UPDATE `users` SET `name` = :name WHERE `id` = :id',
+    ['name' => 'joker', 'id' => 1]
+);
+```
+
+Both named parameters and positional placeholders are supported. Numeric keys in the bind array are converted to 1-based positional parameters:
+
+```php
+$rows = $connection->query('SELECT * FROM `users` WHERE `id` = ?', [1]);
+```
+
+#### Configuration
 
-$connection->query('SELECT * FROM `users` WHERE `id` = :id', ['id' => 1]);
+Only `type` is required; everything else has a sensible default.
 
-$connection->execute('UPDATE `users` SET `name` = "joker" where `id` = :id', ['id' => 1]);
+| key | description | default |
+| ------ | ------ | ------ |
+| `type` | Connector name: `mysql`, `pgsql`, `sqlite`, `sqlsrv` | (required) |
+| `hostname` | Server host | `127.0.0.1` |
+| `hostport` | Server port | `3306` |
+| `database` | Database name. For SQLite, the path to the database file | `''` |
+| `username` | Username | `''` |
+| `password` | Password | `''` |
+| `charset` | MySQL connection charset | — |
+| `socket` | MySQL unix socket; takes precedence over `hostname`/`hostport` | — |
+| `dsn` | Full DSN string; bypasses the auto-generated DSN | — |
+| `params` | PDO attributes, merged over the defaults below | — |
+
+The default PDO attributes (MySQL and SQLite) are:
+
+```php
+[
+    PDO::ATTR_CASE              => PDO::CASE_NATURAL,
+    PDO::ATTR_ERRMODE           => PDO::ERRMODE_EXCEPTION,
+    PDO::ATTR_ORACLE_NULLS      => PDO::NULL_NATURAL,
+    PDO::ATTR_STRINGIFY_FETCHES => false,
+    PDO::ATTR_EMULATE_PREPARES  => false,
+]
+```
+
+Note that `PDO::ATTR_EMULATE_PREPARES` is disabled by default, so queries use native prepared statements where the driver supports them. (The `pgsql` and `sqlsrv` connectors use the same defaults minus `PDO::ATTR_EMULATE_PREPARES`.)
+
+#### SQLite
+
+SQLite only needs the path to the database file:
+
+```php
+$connection = (new Manager([
+    'type'     => 'sqlite',
+    'database' => '/path/to/database.sqlite',
+]))->getConnection();
+```
+
+#### Custom DSN
+
+If the auto-generated DSN is not enough, pass a complete one and it will be used as-is:
+
+```php
+$config = [
+    'type'     => 'mysql',
+    'dsn'      => 'mysql:unix_socket=/tmp/mysql.sock;dbname=test;charset=utf8mb4',
+    'username' => 'root',
+    'password' => 'abc-123',
+];
+```
+
+#### Raw PDO access
+
+```php
+$pdo = $connection->getPdo(); // lazily connects on first access
+$connection->connect();       // or connect explicitly
+
+$statement = $connection->getPdo()->prepare('SELECT VERSION()');
+$statement->execute();
+```
+
+You may also skip the `Manager` entirely and use `Leeqvip\Database\Connection` directly with the same config array.
+
+### Exceptions
+
+- A missing `type` or an unknown connector throws `InvalidArgumentException` when the connection object is created (i.e. in `getConnection()`).
+- Connection and query failures throw `PDOException`.
+
+### Testing
+
+```
+composer install
+vendor/bin/phpunit
 ```
 
 ### License
 
-This project is licensed under the [Apache 2.0 license](LICENSE).
\ No newline at end of file
+This project is licensed under the [Apache 2.0 license](LICENSE).