]> git.immae.eu Git - github/fretlink/squeal-hspec.git/commitdiff
Add information in the README
authorRaveline <eraveline@gmail.com>
Fri, 3 May 2019 09:44:05 +0000 (11:44 +0200)
committerRaveline <eraveline@gmail.com>
Fri, 3 May 2019 09:44:24 +0000 (11:44 +0200)
README.md

index e254c58e2f8a4846ea85d39764c884f906769371..02ed812809f406a85fd966d2873ab0aa31a508d5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,18 @@
 # squeal-hspec
 
-Helpers for creating database tests with hspec and squeal, inspired by Jonathan Fischoff's
+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.
+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.
+`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.
+
+Setting the env var `TEST_DB_CONNECTION_STRING` will let you use a non-temporary
+database if need be. Tear down will run the `migrateDown` to make sure the test
+db doesn't get filled with invalid data.