Add more readme

This commit is contained in:
Ege Emir Özkan
2020-08-16 23:11:54 +03:00
parent ac0148a116
commit f9a993c394
6 changed files with 152 additions and 5 deletions

23
docs/installation.rst Normal file
View File

@@ -0,0 +1,23 @@
Getting Started
=================
Welcome to the documentation of datalite. Datalite provides a simple, intuitive way to bind dataclasses
to sqlite3 databases. In its current version, it provides implicit support for conversion between
``int``, ``float``, ``str``, ``bytes`` classes and their ``sqlite3`` counterparts, default values,
basic schema migration and fetching functions.
Installation
############
Simply write:
.. code-block:: bash
pip install datalite
In the shell. And then, whenever you want to use it in Python, you can use:
.. code-block:: python
import datalite