mirror of
https://github.com/silverqx/TinyORM.git
synced 2026-05-03 15:09:26 -05:00
silverqx
45 lines
2.7 KiB
Markdown
45 lines
2.7 KiB
Markdown
<h1><img src="https://github.com/silverqx/TinyORM/blob/main/resources/icons/logo-optim.svg" width="34" height="34" alt="TinyORM Logo" align="center"> TinyORM</h1>
|
|
|
|
[![MSVC 2019][action-msvc-badge]][action-msvc]
|
|
[![Linux GCC/Clang][action-linux-badge]][action-linux]
|
|
[![MSYS2 UCRT64 GCC/Clang][action-mingw-badge]][action-mingw]
|
|
[![Clang Tidy/Clazy][action-analyzers-badge]][action-analyzers]
|
|
|
|
[![www.tinyorm.org][docs-badge]][docs]
|
|
[![License MIT][license-badge]][license]
|
|
|
|
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. 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.
|
|
|
|
## Documentation
|
|
|
|
Whole library is documented as markdown documents:
|
|
|
|
[![www.tinyorm.org][docs-badge]][docs]
|
|
|
|
- [Documentation: Index](/docs/README.mdx#prologue)
|
|
- [Dependencies](/docs/dependencies.mdx#dependencies)
|
|
- [Supported Compilers](/docs/supported-compilers.mdx#supported-compilers)
|
|
- [Database: Getting Started](/docs/database.mdx#database-getting-started)
|
|
- [Database: Query Builder](/docs/query-builder.mdx#database-query-builder)
|
|
- [Database: Migrations](/docs/migrations.mdx#database-migrations)
|
|
- [TinyORM: Getting Started](/docs/tinyorm.mdx#tinyorm-getting-started)
|
|
- [TinyORM: Relationships](/docs/tinyorm-relationships.mdx#tinyorm-relationships)
|
|
- [Building: TinyORM](/docs/building-tinyorm.mdx#building-tinyorm)
|
|
- [Building: Hello world](/docs/building-hello-world.mdx#building-hello-world)
|
|
- [Building: Migrations](/docs/building-migrations.mdx#building-migrations)
|
|
|
|
[action-msvc]: https://github.com/silverqx/TinyORM/actions/workflows/msvc.yml
|
|
[action-msvc-badge]: https://github.com/silverqx/TinyORM/actions/workflows/msvc.yml/badge.svg
|
|
[action-linux]: https://github.com/silverqx/TinyORM/actions/workflows/linux.yml
|
|
[action-linux-badge]: https://github.com/silverqx/TinyORM/actions/workflows/linux.yml/badge.svg
|
|
[action-mingw]: https://github.com/silverqx/TinyORM/actions/workflows/mingw.yml
|
|
[action-mingw-badge]: https://github.com/silverqx/TinyORM/actions/workflows/mingw.yml/badge.svg
|
|
[action-analyzers]: https://github.com/silverqx/TinyORM/actions/workflows/analyzers.yml
|
|
[action-analyzers-badge]: https://github.com/silverqx/TinyORM/actions/workflows/analyzers.yml/badge.svg
|
|
[docs-badge]: https://img.shields.io/badge/Docs-www.tinyorm.org-blue
|
|
[docs]: https://www.tinyorm.org
|
|
[license-badge]: https://img.shields.io/github/license/silverqx/TinyORM
|
|
[license]: https://github.com/silverqx/TinyORM/blob/main/LICENSE
|