diff --git a/README.md b/README.md index f6ee9e55901d66919dbf46b824e8ffd436d4b63b..0cc7bc83b45404ef732298fc7099ab1bc2e752c2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ -wordpress-redis-backend -======================= +## Overview -A WordPress object cache that uses Redis for storage. \ No newline at end of file +A WordPress object cache backend that implements all available methods using Redis and the Predis library for PHP. + +## Authors + +* Eric Mann + +## Installation +1. Install and configure Redis. There is a good tutorial (here)[http://www.saltwebsites.com/2012/install-redis-245-service-centos-6]. +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. \ No newline at end of file