docs: improve

Author: alex8088

README.md

@@ -1,6 +1,18 @@
-# sqlite3-queries
+<h1 align="center">sqlite3-queries</h1>
 
-> A type-safe and promise-based query client for node sqlite3.
+<p align="center">A type-safe and promise-based query client for node sqlite3</p>
+
+<p align="center">
+<img src="https://img.shields.io/npm/v/sqlite3-queries?color=orange&label=version">
+<img src="https://img.shields.io/github/license/alex8088/sqlite3-queries?color=blue" alt="license" />
+</p>
+
+## Features
+
+- SQL-based
+- Promise-based
+- Type-safe
+- Support automatic migration
 
 ## Install
 
@@ -10,15 +22,14 @@ npm i sqlite3 sqlite3-queries
 
 ## Usage
 
-### Opening Database
+#### Opening Database
 
 - Open an anonymous in-memory database
 
 ```ts
 import { Dbo } from 'sqlite3-queries'
 
 const dbo = new Dbo()
-
 await dbo.open()
 ```
 
@@ -29,26 +40,25 @@ import path from 'node:path'
 import { Dbo } from 'sqlite3-queries'
 
 const dbo = new Dbo(path.join(__dirname, '/tmp/database.db'))
-
 await dbo.open()
 ```
 
 - Open a verbose database for debugging
 
 ```ts
 import { Dbo } from 'sqlite3-queries'
-const dbo = new Dbo(':memory:', { verbose: true })
 
+const dbo = new Dbo(':memory:', { verbose: true })
 await dbo.open()
 ```
 
-### Closing Database
+#### Closing Database
 
 ```ts
 await dbo.close()
 ```
 
-### Tracing and Logging
+#### Tracing and Logging
 
 ```js
 import { Dbo } from 'sqlite3-queries'
@@ -63,7 +73,7 @@ const dbo = new Dbo(Dbo.IN_MEMORY_PATH, {
 await dbo.open()
 ```
 
-### Automatic Migration
+#### Automatic Migration
 
 ```js
 import path from 'node:path'
@@ -148,21 +158,21 @@ declare class DbContext {
 
 Promise-based APIs for sqlite3.
 
-### `Open`
+#### `Open`
 
-**Type:** `(mode?: number) => Promise<void>`
+Type: `(mode?: number) => Promise<void>`
 
 Open the database. The `mode` is one or more of `Dbo.OPEN_READONLY`, `Dbo.OPEN_READWRITE`, `Dbo.OPEN_CREATE`, `Dbo.OPEN_FULLMUTEX`, `Dbo.OPEN_URI`, `Dbo.OPEN_SHAREDCACHE`, `Dbo.OPEN_PRIVATECACHE`. Default: `OPEN_READWRITE | OPEN_CREATE | OPEN_FULLMUTEX`.
 
-### `Close`
+#### `Close`
 
-**Type:** `() => Promise<void>`
+Type: `() => Promise<void>`
 
 Close the database.
 
-### `Run`
+#### `Run`
 
-**Type:** `(sql: string, params?: SqlQueryParam | (string | number)[]) => Promise<RunResult>`
+Type: `(sql: string, params?: SqlQueryParam | (string | number)[]) => Promise<RunResult>`
 
 Runs the SQL query with the specified parameters.
 
@@ -180,9 +190,9 @@ const sql = `UPDATE user SET name = $name WHERE id = $id`
 const result = await dbo.run(sql, { $id: 0, $name: 'Evie Le' })
 ```
 
-### `Get`
+#### `Get`
 
-**Type:** `<T extends Record<string, any>>(sql: string, params?: SqlQueryParam | (string | number)[]) => Promise<T | undefined>`
+Type: `<T extends Record<string, any>>(sql: string, params?: SqlQueryParam | (string | number)[]) => Promise<T | undefined>`
 
 Runs the SQL query with the specified parameters and returns a subsequent result row. If data is not found, `undefined` is returned.
 
@@ -193,9 +203,9 @@ const result = await dbo.get<{ id: number; name: string }>(sql, [0])
 // Output: {id: 0, name: 'Evie Le'}
 ```
 
-### `All`
+#### `All`
 
-**Type:** `<T extends Record<string, any>>(sql: string, params?: SqlQueryParam | (string | number)[]) => Promise<T[]>`
+Type: `<T extends Record<string, any>>(sql: string, params?: SqlQueryParam | (string | number)[]) => Promise<T[]>`
 
 Runs the SQL query with the specified parameters and returns all result rows afterwards.
 
@@ -206,21 +216,21 @@ const result = await dbo.all<{ id: number; name: string }>(sql)
 // Output: [{id: 0, name: 'Evie Le'}]
 ```
 
-### `Exec`
+#### `Exec`
 
-**Type:** `(sql: string) => Promise<void>`
+Type: `(sql: string) => Promise<void>`
 
 Runs all SQL queries in the supplied string.
 
-### `Prepare`
+#### `Prepare`
 
-**Type:** `(sql: string, runCallback: (stmt: Statement) => void) => void`
+Type: `(sql: string, runCallback: (stmt: Statement) => void) => void`
 
 Prepares the SQL statement and run the callback with the statement object.
 
-### `Transaction`
+#### `Transaction`
 
-**Type:** `(transactions: () => void) => Promise<void>`
+Type: `(transactions: () => void) => Promise<void>`
 
 Start a transaction explicitly. A transaction is the propagation of one or more changes to the database. For example, if you are creating, updating, or deleting a record from the table, then you are performing transaction on the table. It is important to control transactions to ensure data integrity and to handle database errors.
 
@@ -235,21 +245,21 @@ await dbo.transaction(() => {
 })
 ```
 
-### `LoadExtension`
+#### `LoadExtension`
 
-**Type:** `(fileName: string) => Promise<void>`
+Type: `(fileName: string) => Promise<void>`
 
 Loads a compiled SQLite extension into the database connection object.
 
-### `Vacuum`
+#### `Vacuum`
 
-**Type:** `() => Promise<void>`
+Type: `() => Promise<void>`
 
 Rebuild the database file, repacking it into a minimal amount of disk space.
 
-### `Pragma`
+#### `Pragma`
 
-**Type:** `<T extends Record<string, any>>(flag: string, value?: string | number): Promise<T | undefined>`
+Type: `<T extends Record<string, any>>(flag: string, value?: string | number): Promise<T | undefined>`
 
 Executes the PRAGMA command to modify the operation of the SQLite library or to query the library for internal (non-table) data.
 
@@ -261,15 +271,15 @@ dbo.pragma('cache_size')
 dbo.pragma('cache_size', 1000 * 1024)
 ```
 
-### `Escape`
+#### `Escape`
 
-**Type:** `(str: string) => string`
+Type: `(str: string) => string`
 
 Escape the `/`, `%`, and `_` characters of query parameters.
 
-### `toSqlQueryParam`
+#### `toSqlQueryParam`
 
-**Type:** `(param: Record<string, string | number>) => SqlQueryParam`
+Type: `(param: Record<string, string | number>) => SqlQueryParam`
 
 Convert object parameters to sql query parameters. All object keys will be prefixed with `$`.