Skip to content

Commit 5d8d19e

Browse files
committed
Revise README.md to update library description and highlight compile-time validation features.
1 parent 3e753a3 commit 5d8d19e

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,19 @@
1515
![](https://img.shields.io/static/v1?label=&message=iOS&color=blue)
1616
![](https://img.shields.io/static/v1?label=&message=Android&color=blue)
1717

18-
A high-performance, non-blocking database driver for PostgreSQL, MySQL, and SQLite, written for Kotlin Multiplatform.
18+
The Kotlin SQL Toolkit. A multiplatform, async SQL library with compile-time query checks. Supports PostgreSQL, MySQL,
19+
and SQLite.
20+
21+
---
22+
23+
**sqlx4k** is not an ORM. Instead, it provides a comprehensive toolkit of primitives and utilities to communicate
24+
directly with your database. The focus is on giving you control while catching errors early through compile-time query
25+
validation—preventing runtime surprises before they happen
26+
(see [SQL syntax validation (compile-time)](#sql-syntax-validation-compile-time)
27+
and [SQL schema validation (compile-time)](#sql-schema-validation-compile-time) for more details).
28+
29+
The library is designed to be extensible, with a growing ecosystem of tools and extensions like PGMQ (PostgreSQL Message
30+
Queue), SQLDelight integration, and more.
1931

2032
📖 [Documentation](https://smyrgeorge.github.io/sqlx4k/)
2133

0 commit comments

Comments
 (0)