cache-service - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

package.json

 {
   "name": "cache-service",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A tiered caching solution for node.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -126,2 +126,30 @@ # cache-service
 
+## redisData (only for use with `type` 'redis')
+
+This is the most generic way to pass in your redis configuraiton options.
+
+* type: object
+
+#### Example
+
+```javascript
+var redisData = {
+  port: myRedisPort,
+  hostname: myRedisHostname,
+  auth: myRedisAuth
+}
+```
+
+## redisUrl (only for use with `type` 'redis')
+
+If you have all of your redis params already prepared as a URL in the following format: `http://uri:password@hostname:port`, then you can simply pass that URL with the object key `redisUrl`.
+
+* type: string
+
+## redisEnv
+
+If you have a redis URL contained in an env variable (in process.env[redisEnv]), cache-service can retrieve it for you if you pass the env variable name with the object key `redisEnv`.
+
+* type: string (only for use with `type` 'redis')
+
 ## defaultExpiration
@@ -128,0 +156,0 @@

No alert changes

Improved metrics

Total package byte prevSize

27506

2.88%

Number of lines in readme file

215

14.97%

No dependency changes