Skip to content

Commit

Permalink
Have README.md and index.rst agree on prologue text
Browse files Browse the repository at this point in the history
  • Loading branch information
ocharles committed Mar 16, 2017
1 parent 8b0c9a9 commit 466ea76
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,15 @@
Welcome to Rel8! Rel8 is an API built on top of the
fantastic [Opaleye](https://hackage.haskell.org/package/opaleye) library to
provide an easy and type-safe way to interact with relational databases.

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, it should never be a
requirement that the user must provide a type signature to allow a program to
compile.

* *Compatible*: Rel8 tries to use the existing Opaleye API as much as possible.
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Welcome to Rel8!
================================

Welcome to Rel8!
Welcome to Rel8! Rel8 is an API built on top of the
fantastic [Opaleye](https://hackage.haskell.org/package/opaleye) library to
provide an easy and type-safe way to interact with relational databases.

Rel8 is a library that builds open the fantastic `Opaleye
<https://hackage.haskell.org/package/opaleye>`_ library to query databases, and
provides a slightly alternative API. The main objectives of Rel8 are:
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
Expand Down

0 comments on commit 466ea76

Please sign in to comment.