]> git.immae.eu Git - github/fretlink/squeal-hspec.git/commitdiff
Add minimal README
authorRaveline <eraveline@gmail.com>
Wed, 9 Jan 2019 09:43:30 +0000 (10:43 +0100)
committerRaveline <eraveline@gmail.com>
Wed, 9 Jan 2019 09:43:30 +0000 (10:43 +0100)
README.md

index 56f44b9673bfc39b271ef096c8945471fe426ceb..e254c58e2f8a4846ea85d39764c884f906769371 100644 (file)
--- 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.