diff --git a/README.md b/README.md index e4eae81810715a5201ddc0ea2fee63022f3ab147..21b58855949dcfdc183acef12672573cb983821c 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,28 @@ A WordPress object cache backend that implements all available methods using Red 2. Install Predis (included in this repository as a submodule) in the `/wp-content/predis` directory, since that's where the object cache expects it to reside. 3. Add object-cache.php to the wp-content directory. It is a drop-in file, not a plugin, so it belongs in the wp-content directory, not the plugins directory. 4. By default, the script will connect to Redis at 127.0.0.1:6379. + +### Connecting to Redis ### + +By default Predis uses `127.0.0.1` and `6379` as the default host and port when creating a new client +instance without specifying any connection parameter: + +```php +$redis = new Predis\Client(); +$redis->set('foo', 'bar'); +$value = $redis->get('foo'); +``` + +It is possible to specify the various connection parameters using URI strings or named arrays: + +```php +$redis = new Predis\Client('tcp://10.0.0.1:6379'); + +// is equivalent to: + +$redis = new Predis\Client(array( + 'scheme' => 'tcp', + 'host' => '10.0.0.1', + 'port' => 6379, +)); +```