Initial stab at better documentation.
This commit is contained in:
33
README.rst
Normal file
33
README.rst
Normal file
@ -0,0 +1,33 @@
|
||||
Fiber ORM
|
||||
~~~~~~~~~
|
||||
|
||||
Lightweight ORM supporting the `Postgres`_ and `SQLite`_ databases in Nim.
|
||||
It supports a simple, opinionated model mapper to generate SQL queries based
|
||||
on Nim objects. It also includes a simple connection pooling implementation.
|
||||
|
||||
.. _Postgres: https://nim-lang.org/docs/db_postgres.html
|
||||
.. _SQLite: https://nim-lang.org/docs/db_sqlite.html
|
||||
|
||||
Basic Usage
|
||||
===========
|
||||
|
||||
Object-Relational Modeling
|
||||
==========================
|
||||
|
||||
Model Class
|
||||
-----------
|
||||
|
||||
Table Name
|
||||
``````````
|
||||
|
||||
Column Names
|
||||
````````````
|
||||
|
||||
ID Field
|
||||
````````
|
||||
|
||||
Supported Data Types
|
||||
--------------------
|
||||
|
||||
Database Object
|
||||
===============
|
Reference in New Issue
Block a user