Skip to content

Commit

Permalink
Move "welcome" to index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ocharles committed Mar 16, 2017
1 parent f8d8c9d commit f339082
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
16 changes: 16 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
Welcome to Rel8!
================================

Welcome to Rel8!

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:

* *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.

.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down
20 changes: 3 additions & 17 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
Getting Started
===============

Welcome to Rel8!

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:

* *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.

Now, let's dive in and see an example of a program using Rel8.
In this article, we'll take a tour through the basics of Rel8. We'll learn how
to define base tables, write simple queries, and execute these queries against a
real database.


Required language extensions and imports
Expand Down

0 comments on commit f339082

Please sign in to comment.