diff --git a/docs/README.mdx b/docs/README.mdx index a35cfca51..f3185f0a2 100644 --- a/docs/README.mdx +++ b/docs/README.mdx @@ -3,14 +3,14 @@ title: Prologue sidebar_position: 0 slug: / hide_table_of_contents: true -description: TinyORM is a modern ORM library that makes interacting with a database extremely simple. The code is well tested with the unit and functional tests. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against a real MySQL database. +description: TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the QtCore and QtSql libraries. The code is written in the modern c++20 way and is well tested with the unit and functional tests. --- # Prologue -TinyORM is a modern ORM library that makes interacting with a database extremely simple. +TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the `QtCore` and `QtSql` libraries. -The code is well tested with the unit and functional tests. Almost all the query builder methods are unit tested. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against all supported databases. For now, the code coverage is not ideal but is good enough to guarantee API and behavior compatibility. +The code is written in the modern c++20 way and is well tested with the unit and functional tests. Almost all the query builder methods are unit tested. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against all supported databases. For now, the code coverage is not ideal but is good enough to guarantee API and behavior compatibility. - [Dependencies](dependencies.mdx#dependencies) - [Supported Compilers](supported-compilers.mdx#supported-compilers)