ocbesbn-redis-events - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

index.js

@@ -209,3 +209,3 @@ 'use strict'
  * @property {object} consul.redisServiceName - Name of the enpoint for the Redis server in consul.
- * @property {object} consul.redisPasswordKey - Consul configuration key for Redis authorisation.
+ * @property {object} consul.redisPasswordKey - Consul configuration key for Redis authorisation. Might be null or false if not desired to be used.
  * @property {object} context - Optional context object to automatically extend emitted messages.
@@ -233,3 +233,3 @@ */
             ep : consul.getEndPoint(config.consul.redisServiceName),
-            password : consul.get(config.consul.redisPasswordKey)
+            password : config.consul.redisPasswordKey && consul.get(config.consul.redisPasswordKey)
         });
@@ -236,0 +236,0 @@ })

package.json

 {
   "name": "ocbesbn-redis-events",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Module simplifying access to the publish/subscribe system provided by Redis.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,3 +5,3 @@ # ocbesbn-redis-events
 
-This module provides simplified access to the publish/subscribe system provided by Redis. To have a look at the full API, please visit the related [wiki page](https://github.com/OpusCapita/redis-events/wiki).
+This module provides simplified access to the publish/subscribe system provided by Redis. It uses Consul in order to determine the required Redis server endpoint and further configurations. To have a look at the full API, please visit the related [wiki page](https://github.com/OpusCapita/redis-events/wiki).
 
@@ -13,5 +13,5 @@ ### Minimum setup
 ```
-To go with the minimum setup, you need to have access to a running Consul server to get your endpoint configuration and a Redis server that is registered in consul.
+To go with the minimum setup, you need to have access to a running **Consul server** to get your endpoint configuration for Redis. In addition, a **Redis server** is required which has to be registered inside Consul. If Redis password **authentication** is required, Consul has to provide the configuration key **{{your-service-name}}/redis/password** where *{{your-service-name}}* is the least name of the directory your code runs in. If authentication is not used, you can set the **consul.redisPasswordKey** to null or false when creating a new instance of RedisEvents.
 
-If all this is set up, go to you code and add the following command:
+If all this is set up, go to you code and add the following lines:
 
@@ -18,0 +18,0 @@ ```JS

wiki/Home.md

@@ -134,4 +134,4 @@ <a name="RedisEvents"></a>
 | consul.redisServiceName | <code>object</code> | Name of the enpoint for the Redis server in consul. |
-| consul.redisPasswordKey | <code>object</code> | Consul configuration key for Redis authorisation. |
+| consul.redisPasswordKey | <code>object</code> | Consul configuration key for Redis authorisation. Might be null or false if not desired to be used. |
 | context | <code>object</code> | Optional context object to automatically extend emitted messages. |
 

No alert changes

Improved metrics

Total package byte prevSize

28721

increased by2.28%

No dependency changes