docs bugfix TinyDrivers missing README.md GitHub

[skip ci]
silverqx · May 5, 2024 · 1dd3e13 · 1dd3e13
1 parent e79936c
commit 1dd3e13
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/README.mdx b/docs/README.mdx
@@ -36,6 +36,8 @@ If you don't want to use full [`ORM`](tinyorm/getting-started.mdx), then you can
   - [Collections](tinyorm/collections.mdx)
   - [Casts](tinyorm/casts.mdx)
   - [Serialization](tinyorm/serialization.mdx)
+- [TinyDrivers](tinydrivers/getting-started.mdx)
+  - [Getting Started](tinydrivers/getting-started.mdx)
 - [Building](building/tinyorm.mdx)
   - [TinyORM](building/tinyorm.mdx)
   - [Hello world](building/hello-world.mdx)

diff --git a/docs/tinydrivers/README.md b/docs/tinydrivers/README.md
@@ -0,0 +1,7 @@
+# TinyDrivers
+
+The `TinyDrivers` library is an underlying SQL database layer for `TinyORM`. It can be used instead of the `QtSql` module, can be <u>__swapped__</u> at compile time, and has __1:1__ API as the `QtSql` module. 😮 Swapping is controlled by the `qmake` and `CMake` build system options.
+
+It was designed to drop the `QtSql` dependency while maintaining backward compatibility and without the need for any code changes after the swap.
+
+- [Getting Started](getting-started.mdx#tinydrivers-getting-started)