Prepare for release 0.1.3.
This commit is contained in:
James Coglan
@@ -2,7 +2,6 @@
|
||||
.gitignore
|
||||
.gitmodules
|
||||
.npmignore
|
||||
.redcar
|
||||
.travis.yml
|
||||
dump.rdb
|
||||
Rakefile
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
# faye-redis [](http://travis-ci.org/faye/faye-redis-node)
|
||||
|
||||
This plugin provides a Redis-based backend for the [Faye](http://faye.jcoglan.com)
|
||||
messaging server. It allows a single Faye service to be distributed across many
|
||||
front-end web servers by storing state and routing messages through a
|
||||
[Redis](http://redis.io) database server.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Pass in the engine and any settings you need when setting up your Faye server.
|
||||
|
||||
```js
|
||||
var faye = require('faye'),
|
||||
redis = require('faye-redis'),
|
||||
http = require('http');
|
||||
|
||||
var server = http.createServer();
|
||||
|
||||
var bayeux = new faye.NodeAdapter({
|
||||
mount: '/',
|
||||
timeout: 25,
|
||||
engine: {
|
||||
type: redis,
|
||||
host: 'redis.example.com',
|
||||
// more options
|
||||
}
|
||||
});
|
||||
|
||||
bayeux.attach(server);
|
||||
server.listen(8000);
|
||||
```
|
||||
|
||||
The full list of settings is as follows.
|
||||
|
||||
* <b><tt>host</tt></b> - hostname of your Redis instance
|
||||
* <b><tt>port</tt></b> - port number, default is `6379`
|
||||
* <b><tt>password</tt></b> - password, if `requirepass` is set
|
||||
* <b><tt>database</tt></b> - number of database to use, default is `0`
|
||||
* <b><tt>namespace</tt></b> - prefix applied to all keys, default is `''`
|
||||
* <b><tt>socket</tt></b> - path to Unix socket if `unixsocket` is set
|
||||
|
||||
|
||||
## License
|
||||
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2011-2013 James Coglan
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the 'Software'), to deal in
|
||||
the Software without restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
# faye-redis [](http://travis-ci.org/faye/faye-redis-node)
|
||||
|
||||
This plugin provides a Redis-based backend for the
|
||||
[Faye](http://faye.jcoglan.com) messaging server. It allows a single Faye
|
||||
service to be distributed across many front-end web servers by storing state
|
||||
and routing messages through a [Redis](http://redis.io) database server.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Pass in the engine and any settings you need when setting up your Faye server.
|
||||
|
||||
```js
|
||||
var faye = require('faye'),
|
||||
redis = require('faye-redis'),
|
||||
http = require('http');
|
||||
|
||||
var server = http.createServer();
|
||||
|
||||
var bayeux = new faye.NodeAdapter({
|
||||
mount: '/',
|
||||
timeout: 25,
|
||||
engine: {
|
||||
type: redis,
|
||||
host: 'redis.example.com',
|
||||
// more options
|
||||
}
|
||||
});
|
||||
|
||||
bayeux.attach(server);
|
||||
server.listen(8000);
|
||||
```
|
||||
|
||||
The full list of settings is as follows.
|
||||
|
||||
* <b>`host`</b> - hostname of your Redis instance
|
||||
* <b>`port`</b> - port number, default is `6379`
|
||||
* <b>`password`</b> - password, if `requirepass` is set
|
||||
* <b>`database`</b> - number of database to use, default is `0`
|
||||
* <b>`namespace`</b> - prefix applied to all keys, default is `''`
|
||||
* <b>`socket`</b> - path to Unix socket if `unixsocket` is set
|
||||
|
||||
|
||||
## License
|
||||
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2011-2013 James Coglan
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the 'Software'), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@
|
||||
, "author" : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
|
||||
, "keywords" : ["pubsub", "bayeux"]
|
||||
|
||||
, "version" : "0.1.2"
|
||||
, "version" : "0.1.3"
|
||||
, "engines" : {"node": ">=0.4.0"}
|
||||
, "main" : "./faye-redis"
|
||||
, "dependencies" : {"redis": ""}
|
||||
|
||||
Reference in New Issue
Block a user