Merge pull request #45 from lcache/20-readme-updates

Update readme with better installation instructions + minimum reqs

README.md

@@ -1,8 +1,8 @@
 # WP LCache #
-**Contributors:** getpantheon, danielbachhuber  
+**Contributors:** getpantheon, danielbachhuber, stevector  
 **Tags:** cache, plugin  
 **Requires at least:** 4.3  
-**Tested up to:** 4.6  
+**Tested up to:** 4.6.1  
 **Stable tag:** 0.0.0  
 **License:** GPLv2 or later  
 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
@@ -15,21 +15,29 @@ Supercharge your WP Object Cache with LCache, a persistent, performant, and mult
 
 For sites concerned with high traffic, speed for logged-in users, or dynamic pageloads, a high-speed and persistent object cache is a must. WP LCache improves upon Memcached and Redis implementations by using APCu, PHP's in-memory cache, in a way that's compatible with multiple web nodes.
 
-Under the hood, WP LCache uses [LCache](https://github.com/lcache/lcache), a library that applies the tiered caching model of multi-core processors (with local L1 and central L2 caches) to web applications. In this configuration, APCu is the L1 cache and the database is the L2 cache.
+Under the hood, WP LCache uses [LCache](https://github.com/lcache/lcache), a library that applies the tiered caching model of multi-core processors (with local L1 and central L2 caches) to web applications. In this configuration, APCu is the L1 cache and the database is the L2 cache. APCu traditionally can't be used on multiple web nodes because each web node represents a different cache pool. Because WP LCache has a database-based L2 cache, a cache update or delete on one node can then be applied to all other nodes.
 
-Install WP LCache from [WordPress.org](https://wordpress.org/plugins/wp-lcache/) or [Github](https://github.com/lcache/wp-lcache).
+Read the installation instructions, then install WP LCache from [WordPress.org](https://wordpress.org/plugins/wp-lcache/) or [Github](https://github.com/lcache/wp-lcache).
 
 Go forth and make awesome! And, once you've built something great, [send us feature requests (or bug reports)](https://github.com/lcache/wp-lcache/issues).
 
 ## Installation ##
 
-WP LCache requires PHP 5.5 or greater with the appropriate APCu module installed. If APCu is unavailable, you'll see an admin notice in your WordPress dashboard.
+**WP LCache requires PHP 5.6 or greater with the APCu extension enabled.** If you're running an older PHP version, or APCu is unavailable, you'll see an admin notice in your WordPress dashboard.
 
-Once you've verfied APCu is configured appropriately:
+To install WP LCache, follow these steps:
 
-1. Install `object-cache.php` to `wp-content/object-cache.php` with a symlink.
+1. Install the plugin from WordPress.org using the WordPress dashboard or WP-CLI.
+1a. Those installing from Github will need to run `composer install --no-dev` after cloning to get the LCache library.
+2. Activate the plugin, to ensure LCache's database tables are created. These are created on the plugin activation hook.
+3. Symlink the object cache drop-in to its appropriate location: `cd wp-content; ln -s plugins/wp-lcache/object-cache.php object-cache.php`
 
-That's it!
+If you need to install APCu, the PECL installer is the easiest way to do so.
+
+* PHP 7.0: `pecl install apcu`
+* PHP 5.6: `pecl install channel://pecl.php.net/apcu-4.0.11`
+
+If you can't easily use PHP 5.6 or greater, you should switch to a more responsible hosting provider.
 
 ## Contributing ##
 
@@ -52,5 +60,5 @@ Behat requires a Pantheon site. Once you've created the site, you'll need [insta
 
 ## Changelog ##
 
-### 0.1.0 (???? ??, ????) ###
+### 0.1.0 (September 7th, 2016) ###
 * Initial release.

readme.txt

@@ -1,8 +1,8 @@
 === WP LCache ===
-Contributors: getpantheon, danielbachhuber
+Contributors: getpantheon, danielbachhuber, stevector
 Tags: cache, plugin
 Requires at least: 4.3
-Tested up to: 4.6
+Tested up to: 4.6.1
 Stable tag: 0.0.0
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
@@ -15,21 +15,29 @@ Supercharge your WP Object Cache with LCache, a persistent, performant, and mult
 
 For sites concerned with high traffic, speed for logged-in users, or dynamic pageloads, a high-speed and persistent object cache is a must. WP LCache improves upon Memcached and Redis implementations by using APCu, PHP's in-memory cache, in a way that's compatible with multiple web nodes.
 
-Under the hood, WP LCache uses [LCache](https://github.com/lcache/lcache), a library that applies the tiered caching model of multi-core processors (with local L1 and central L2 caches) to web applications. In this configuration, APCu is the L1 cache and the database is the L2 cache.
+Under the hood, WP LCache uses [LCache](https://github.com/lcache/lcache), a library that applies the tiered caching model of multi-core processors (with local L1 and central L2 caches) to web applications. In this configuration, APCu is the L1 cache and the database is the L2 cache. APCu traditionally can't be used on multiple web nodes because each web node represents a different cache pool. Because WP LCache has a database-based L2 cache, a cache update or delete on one node can then be applied to all other nodes.
 
-Install WP LCache from [WordPress.org](https://wordpress.org/plugins/wp-lcache/) or [Github](https://github.com/lcache/wp-lcache).
+Read the installation instructions, then install WP LCache from [WordPress.org](https://wordpress.org/plugins/wp-lcache/) or [Github](https://github.com/lcache/wp-lcache).
 
 Go forth and make awesome! And, once you've built something great, [send us feature requests (or bug reports)](https://github.com/lcache/wp-lcache/issues).
 
 == Installation ==
 
-WP LCache requires PHP 5.5 or greater with the appropriate APCu module installed. If APCu is unavailable, you'll see an admin notice in your WordPress dashboard.
+**WP LCache requires PHP 5.6 or greater with the APCu extension enabled.** If you're running an older PHP version, or APCu is unavailable, you'll see an admin notice in your WordPress dashboard.
 
-Once you've verfied APCu is configured appropriately:
+To install WP LCache, follow these steps:
 
-1. Install `object-cache.php` to `wp-content/object-cache.php` with a symlink.
+1. Install the plugin from WordPress.org using the WordPress dashboard or WP-CLI.
+1a. Those installing from Github will need to run `composer install --no-dev` after cloning to get the LCache library.
+2. Activate the plugin, to ensure LCache's database tables are created. These are created on the plugin activation hook.
+3. Symlink the object cache drop-in to its appropriate location: `cd wp-content; ln -s plugins/wp-lcache/object-cache.php object-cache.php`
 
-That's it!
+If you need to install APCu, the PECL installer is the easiest way to do so.
+
+* PHP 7.0: `pecl install apcu`
+* PHP 5.6: `pecl install channel://pecl.php.net/apcu-4.0.11`
+
+If you can't easily use PHP 5.6 or greater, you should switch to a more responsible hosting provider.
 
 == Contributing ==
 
@@ -52,5 +60,5 @@ Behat requires a Pantheon site. Once you've created the site, you'll need [insta
 
 == Changelog ==
 
-= 0.1.0 (???? ??, ????) =
+= 0.1.0 (September 7th, 2016) =
 * Initial release.