From: Raveline <eraveline@gmail.com>
Date: Wed, 9 Jan 2019 09:43:30 +0000 (+0100)
Subject: Add minimal README
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=8c738ffcd5ba7ad6c38303857cd351d01d4bba5f;p=github%2Ffretlink%2Fsqueal-hspec.git

Add minimal README
---

diff --git a/README.md b/README.md
index 56f44b9..e254c58 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,11 @@
 # squeal-hspec
+
+Helpers for creating database tests with hspec and squeal, inspired by Jonathan Fischoff's
+[hspec-pg-transact](http://hackage.haskell.org/package/hspec-pg-transact).
+
+This uses @tmp-postgres@ to automatically and connect to a temporary instance of postgres on a random port.
+
+Current version is done to operate with Squeal 0.4.0.0.
+
+`describeDB` lets you initate a series of `itDB` specs which will operate in the same context.
+It takes migrations to run and a series of fixtures to fill the database.