README tweaks.

This commit is contained in:
Matteo Collina 2015-12-31 11:22:07 +01:00
parent 3b61df18a8
commit 1819672add

View file

@ -23,7 +23,7 @@ Example
var redis = require('mqemitter-redis')
var mq = redis({
port: 12345,
localhost: 12.34.56.78,
host: '12.34.56.78',
password: 'my secret',
db: 4
})
@ -44,6 +44,17 @@ mq.emit(msg, function () {
})
```
## API
<a name="constructor"></a>
### MQEmitterRedis([opts])
Creates a new instance of mqemitter-redis.
It takes all the same options of [ioredis](http://npm.im/ioredis),
which is used internally to connect to Redis.
This constructor creates two connections to Redis.
Acknowledgements
----------------