From 837ea10a0c8a484088dc31b35d6e11a1925bead9 Mon Sep 17 00:00:00 2001 From: Benjamin Coe Date: Thu, 3 Sep 2015 23:56:17 -0700 Subject: [PATCH 1/2] show off redis:// format overloading --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9874922824..85ea259e8d 100644 --- a/README.md +++ b/README.md @@ -155,10 +155,11 @@ If you have `redis-server` running on the same computer as node, then the defaul port and host are probably fine and you don't need to supply any arguments. `createClient()` returns a `RedisClient` object. ### overloading -* `redis.createClient(port,host,options)` +* `redis.createClient(port, host, options)` * `redis.createClient()` is equivalent to `redis.createClient(6379, '127.0.0.1', {})` * `redis.createClient(options)` is equivalent to `redis.createClient(6379, '127.0.0.1', options)` * `redis.createClient(unix_socket, options)` +* `redis.createClient('redis://user:pass@host:port', options)` `options` is an object with the following possible properties: From 1f986055c48c70a8d6a856dae24d5086247164da Mon Sep 17 00:00:00 2001 From: Benjamin Coe Date: Thu, 3 Sep 2015 23:58:12 -0700 Subject: [PATCH 2/2] add a note about how to turn on the debugger --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 85ea259e8d..caeefe5a74 100644 --- a/README.md +++ b/README.md @@ -710,6 +710,10 @@ hiredis parser: GET 4MiB buf, 1/5 min/max/avg/p95: 6/ 13/ 8.01/ 11.95 802ms total, 124.69 ops/sec GET 4MiB buf, 50/5 min/max/avg/p95: 16/ 480/ 203.85/ 435.70 531ms total, 188.32 ops/sec +## Debugging + +To get debug output run your `node_redis` application with `NODE_DEBUG=redis`. + ## TODO 1. 100% coverage