mirror/TinyORM
1
0
Fork 0
mirror of https://github.com/silverqx/TinyORM.git synced 2026-01-06 02:49:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

sync docs, missing links

Browse Source
This commit is contained in:
silverqx
2022-01-02 14:38:10 +01:00
parent 3b1e8b42a8
commit c94bad92c8
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -8,7 +8,9 @@
[![silverqx.github.io][docs-badge]][docs]
[![License MIT][license-badge]][license]
TinyORM is a modern ORM library heavily inspired by Laravel's Eloquent ORM that makes interacting with a database extremely simple.
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
@@ -18,6 +20,10 @@ Whole library is documented as markdown documents:
- [Documentation: Index](/docs/README.mdx#prologue)
- [Dependencies](/docs/dependencies.mdx#dependencies)
- [Supported Compilers](/docs/supported-compilers.mdx#supported-compilers)
- [Building](/docs/building.mdx#building)
- [Hello world](/docs/hello-world.mdx#hello-world)
- [Dependencies](/docs/dependencies.mdx#dependencies)
- [Database: Getting Started](/docs/database.mdx#database-getting-started)
- [Database: Query Builder](/docs/query-builder.mdx#database-query-builder)
- [TinyORM: Getting Started](/docs/tinyorm.mdx#tinyorm-getting-started)

2
docs/README.mdx
View File

@@ -10,7 +10,7 @@ description: TinyORM is a modern ORM library that makes interacting with a datab
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 a real MySQL database. For now, the code coverage is not ideal but is good enough to guarantee API and behavior compatibility.
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.
- [Dependencies](dependencies.mdx)
- [Supported Compilers](supported-compilers.mdx)