From 3d07ee78049fc6b848234cd9e56322cd60a1f641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anton=20Lindstr=C3=B6m?= Date: Tue, 19 Jul 2016 21:21:08 +0200 Subject: [PATCH] Add breaking changes note to README This adds a section about breaking changes and when they were introduced in the README. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b14014..6149668 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,10 @@ See http://www.gorillatoolkit.org/pkg/sessions for full documentation on underly ```go // Fetch new store. -store := NewPGStore("postgres://user:password@127.0.0.1:5432/database?sslmode=verify-full", []byte("secret-key")) +store, err := NewPGStore("postgres://user:password@127.0.0.1:5432/database?sslmode=verify-full", []byte("secret-key")) +if err != nil { + log.Error(err.Error()) +} defer store.Close() // Run a background goroutine to clean up expired sessions from the database. defer store.StopCleanup(store.Cleanup(time.Minute * 5)) @@ -42,6 +45,10 @@ if err = sessions.Save(req, rsp); err != nil { } ``` +## Breaking changes + +* 2016-07-19 - `NewPGStore` and `NewPGStoreFromPool` now returns `(*PGStore, error)` + ## Thanks I've stolen, borrowed and gotten inspiration from the other backends available: