Skip to content

Commit

Permalink
add; custom client support
Browse files Browse the repository at this point in the history
  • Loading branch information
wavded committed May 1, 2015
1 parent 7834df1 commit 47958ee
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Then follow the usage instructions below.
## Options

A Redis client is required. An existing client can be passed directly using the `client` param or created for you using the `host`, `port`, or `socket` params.
- `client` An existing client created using `redis.createClient()`
- `client` An existing client
- `host` Redis server hostname
- `port` Redis server portno
- `socket` Redis server unix_socket
Expand Down Expand Up @@ -45,6 +45,12 @@ Pass the `express-session` store into `connect-redis` to create a `RedisStore` c
secret: 'keyboard cat'
}));

## Custom Redis clients

Clients other than `node_redis` will work if they support the same interface. Just pass the client instance as the `client` configuration option. Known supported clients include:

* [ioredis](https://github.com/luin/ioredis) - adds support for Redis Sentinel and Cluster

## FAQ

#### Can I use a URL scheme to make a connection?
Expand Down

0 comments on commit 47958ee

Please sign in to comment.