on b97cd4e help sign in
rel8/docs/index.rst
38 lines 1.2 kB history raw
1Welcome to Rel8!
2================================
4Welcome to Rel8! Rel8 is a Haskell library for interacting with PostgreSQL
5databases, built on top of the fantastic `Opaleye
6<https://hackage.haskell.org/package/opaleye>`_ library.
8The main objectives of Rel8 are:
10* *Conciseness*: Users using Rel8 should not need to write boiler-plate code.
11 By using expressive types, we can provide sufficient information for the
12 compiler to infer code whenever possible.
14* *Inferrable*: Despite using a lot of type level magic, Rel8 aims to have
15 excellent and predictable type inference.
17* *Familiar*: writing Rel8 queries should feel like normal Haskell programming.
19.. toctree::
20 :maxdepth: 3
21 :caption: Contents:
23 tutorial
24 cookbook
27More Resources
28==============
30* The `Haskell API documentation <https://hackage.haskell.org/package/rel8>`_
31 describes how individual functions are types are to be used.
33* If you have a question about how to use Rel8, feel free to open a `GitHub
34 discussion <https://github.com/circuithub/rel8/discussions>`_.
36* If you think you've found a bug, confusing behavior, or have a feature
37 request, please raise an issue at `Rel8's issue tracker
38 <https://github.com/circuithub/rel8>`_.