From ae687ea20c861833461b32d5e9c10090ff1282f7 Mon Sep 17 00:00:00 2001
From: Benjamin Adams <Armastevs@gmail.com>
Date: Mon, 15 Jul 2013 13:08:01 -0500
Subject: [PATCH] Update Docs

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 47 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 16f77f6..57588a6 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,52 @@
+## Wp Redis Cache
+======
+Cache Wordpress using Redis, the fastest way to date to cache Wordpress.
 
+### Requirements
+------
+[Wordpress](http://wordpress.org) - CMS framework/blogging system
+[Redis](http://redis.io/) - Key Value in memory caching
+[Predis](https://github.com/nrk/predis) - PHP api for Redis
 
+### Setup
+------
+Install Redis, must have root access to your machine. On debian it's as simple as:
+```bash
+sudo apt-get install redis-server
+```
+On other systems please refer to the [Redis website](http://redis.io/).
+
+Move the folder wp-redis-cache to the plugin directory and activate the plugin.  In the admin section you can set how long you will cache the post for.  By default it will cache the post for 12 hours.
+Note: This plugin is optional and is used to refresh the cache after you update a post/page
+
+Move the `index-wp-redis.php` to the root/base Wordpress directory
+Change the `index.php` to:
+```php
+<?php
+require('index-wp-redis.php')
+```
+*Note: Sometimes when you upgrade Wordpress it will replace over your `index.php` file and you will have to redo this step.  This is the reason we don't just replace the contents of `index-wp-redis.php` with `index.php`.
+
+We do this because Wordpress is no longer in charge of displaying our posts.  Redis will now server the post if it is in the cache.  If the post is not in the Redis cache it will then call Wordpress to serve the page and then cache it for the next pageload
+
+
+### Benchmark
+------
+I welcome you to compare the page load times of this caching system with other popular Caching plugins such as [Wp Super Cache](http://wordpress.org/plugins/wp-super-cache/) and [W3 Total Cache](http://wordpress.org/plugins/w3-total-cache/)
 
+With a fresh Wordpress install:
+Wp Super Cache
+```
+Page generated in 0.318 seconds.
+```
+
+W3 Total Cache
+```
+Page generated in 0.30484 seconds.
+```
+
+Wp Redis Cache
+```
+Page generated in 0.00902 seconds.
 ```
-# BEGIN WordPress
-<IfModule mod_rewrite.c>
-RewriteEngine On
-RewriteBase /
-RewriteRule ^index-wp-redis\.php$ - [L]
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteCond %{REQUEST_FILENAME} !-d
-RewriteRule . /index-wp-redis\.php [L]
-</IfModule>
 
-# END WordPress 
-```
\ No newline at end of file
-- 
GitLab