Initial stab at better documentation.

This commit is contained in:
2022-09-02 23:25:52 -05:00
parent 1d7c955805
commit 9bf3c4f3ec
6 changed files with 223 additions and 9 deletions

33
README.rst Normal file
View 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
===============