diff --git a/README.md b/README.md new file mode 100644 index 0000000..99ba018 --- /dev/null +++ b/README.md @@ -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/).