From fbbf24c3548ad29a1e2c8c5466f49ade296ef7a0 Mon Sep 17 00:00:00 2001
From: Benjamin Adams <Armastevs@gmail.com>
Date: Mon, 15 Jul 2013 13:49:04 -0500
Subject: [PATCH] Updated Docs
---
README.md | 4 +-
wp-redis-cache/options.php | 99 ++++++++++++++++++++++++++++++++++++--
2 files changed, 98 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index d1457a1..63b868e 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
## Wp Redis Cache
-------
+
Cache Wordpress using Redis, the fastest way to date to cache Wordpress.
### Requirements
@@ -8,7 +8,7 @@ Cache Wordpress using Redis, the fastest way to date to cache Wordpress.
* [Redis](http://redis.io/) - Key Value in memory caching
* [Predis](https://github.com/nrk/predis) - PHP api for Redis
-== Installation ==
+### Installation
------
Install Redis, must have root access to your machine. On debian it's as simple as:
```bash
diff --git a/wp-redis-cache/options.php b/wp-redis-cache/options.php
index 2a1fd8e..aabb8c1 100644
--- a/wp-redis-cache/options.php
+++ b/wp-redis-cache/options.php
@@ -2,10 +2,101 @@
/*
Plugin Name: Wp Redis Cache
Plugin URI: https://github.com/BenjaminAdams/wp-redis-cache
-Description: Cache Wordpress using Redis, the fastest way to date to cache Wordpress.
Version: 1.0
Author: Benjamin Adams
Author URI: http://dudelol.com
+
+Cache Wordpress using Redis, the fastest way to date to cache Wordpress.
+
+== Description ==
+## Wp Redis Cache
+------
+Cache Wordpress using Redis, the fastest way to date to cache Wordpress.
+
+Please see [https://github.com/BenjaminAdams/wp-redis-cache](https://github.com/BenjaminAdams/wp-redis-cache) for the latest information and other needed setup files
+
+### 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
+
+== Installation ==
+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.
+
+Move the `index.php` to the root/base Wordpress directory. Or manually change the `index.php` to:
+
+```php
+<?php
+require('index-wp-redis.php');
+?>
+```
+In `index-wp-redis.php` change `$ip_of_your_website` to the IP of your server
+
+*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.
+```
+
+
+== Installation ==
+
+== Installation ==
+------
+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.
+
+Move the `index.php` to the root/base Wordpress directory. Or manually change the `index.php` to:
+
+```php
+<?php
+require('index-wp-redis.php');
+?>
+```
+In `index-wp-redis.php` change `$ip_of_your_website` to the IP of your server
+
+*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
+
/* Copyright 2013 Benjamin Adams (email : ben@dudelol.com)
This program is free software; you can redistribute it and/or modify
@@ -20,6 +111,7 @@ Author URI: http://dudelol.com
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
*/
@@ -27,7 +119,7 @@ Author URI: http://dudelol.com
add_action('admin_menu', 'add_redis_interface');
function add_redis_interface() {
- add_options_page('Wp Redis', 'Wp Redis', '8', 'functions', 'edit_redis_options');
+ add_options_page('Wp Redis Cache', 'Wp Redis Cache', '8', 'functions', 'edit_redis_options');
}
function edit_redis_options() {
@@ -37,7 +129,8 @@ function edit_redis_options() {
<form method="post" action="options.php">
<?php wp_nonce_field('update-options') ?>
- <p>This plugin does not work out of the box and requires additional steps. Please follow these install instructions: <a target='_blank' href='https://github.com/BenjaminAdams/wp-redis-cache'>https://github.com/BenjaminAdams/wp-redis-cache</a></p>
+ <p>This plugin does not work out of the box and requires additional steps.<br />
+ Please follow these install instructions: <a target='_blank' href='https://github.com/BenjaminAdams/wp-redis-cache'>https://github.com/BenjaminAdams/wp-redis-cache</a></p>
<p>If you do not have Redis installed on your machine this will NOT work! </p>
--
GitLab