Create README.md

This commit is contained in:
Ollie Charles 2021-04-02 17:43:15 +01:00 committed by GitHub
parent ac6ed40d7e
commit 340346c8c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Welcome!
Welcome to Rel8! Rel8 is a Haskell library for interacting with PostgreSQL databases, built on top of the fantastic Opaleye library.
The main objectives of Rel8 are:
* *Conciseness*: Users using Rel8 should not need to write boiler-plate code. By using expressive types, we can provide sufficient information for the compiler to infer code whenever possible.
* *Inferrable*: Despite using a lot of type level magic, Rel8 aims to have excellent and predictable type inference.
* *Familiar*: writing Rel8 queries should feel like normal Haskell programming.
For more details, check out the [official documentation](https://rel8.readthedocs.io/en/latest/).