@@ -1 +1,18 @@
1−s
1+# Project:M36 Persistent Library Driver
2+
3+Project:M36 includes a driver for the [persistent](https://hackage.haskell.org/package/persistent) library which offers lowest-common-denominator DBMS support for storing and retrieving Haskell-based datatypes. While the persistent library does not support every Project:M36 feature, it can nonetheless be handy for simple use-cases and database-agnostic mapping.
4+
5+For the most part, using the Project:M36 driver should be identical to using other drivers.
6+
7+## Setup
8+
9+Use ```withProjectM36Conn``` with a configuration argument to add a ReaderT to your monad stack. The, follow that with ```runProjectM36Conn``` to run the monad.
10+
11+## Usage
12+
13+At this point, all persistent functions are available. The driver always commits to the "master" branch.
14+
15+## Caveats
16+
17+* Not every persistent data type is supported yet.
18+* Tuple ordering in selects is not yet supported.