Add notes to the Readme and Changelog

envato · Feb 21, 2022 · 4728499 · 4728499
1 parent 800c4ef
commit 4728499
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Changed
+
+- **Breaking**: The Redis check now requires being configured with an instance of the Redis client, via the named `instance` parameter
+
 ### Added
 
 - The `static` check, which uses the provided check parameters to return the same result every time.

diff --git a/README.md b/README.md
@@ -157,7 +157,7 @@ Requires a configured ActiveRecord connection, and that ActiveRecord migrations
 
 #### `redis`
 
-Requires a configured global Redis client. Does not support configuration. Indicates whether the global client is currently connected to the Redis database. On success, returns something in the following format:
+Requires the Redis gem. Requires configuration, an instance of a Redis client. Indicates whether the Redis client passed in is currently connected to the Redis database. On success, returns something in the following format:
 
 ```json
 {