From 133e196549196ebfa209e8f300afce0f773a4894 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Wed, 7 Sep 2016 14:20:43 -0700 Subject: [PATCH 1/4] Update readme with better installation instructions + minimum reqs --- README.md | 23 +++++++++++++++-------- readme.txt | 23 +++++++++++++++-------- 2 files changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4110da3..eedf51e 100644 --- a/README.md +++ b/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,28 @@ 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 module 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. +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 ## diff --git a/readme.txt b/readme.txt index 28ed86b..bf32d9c 100644 --- a/readme.txt +++ b/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,28 @@ 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 module 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. +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 == From f9bb9d5c2a450a08b18bfe79744d59fc2f365446 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Wed, 7 Sep 2016 17:03:04 -0700 Subject: [PATCH 2/4] APCu extension --- README.md | 2 +- readme.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eedf51e..c081b06 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Go forth and make awesome! And, once you've built something great, [send us feat ## Installation ## -**WP LCache requires PHP 5.6 or greater with the APCu module enabled.** If you're running an older PHP version, or 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. To install WP LCache, follow these steps: diff --git a/readme.txt b/readme.txt index bf32d9c..eeb5db1 100644 --- a/readme.txt +++ b/readme.txt @@ -23,7 +23,7 @@ Go forth and make awesome! And, once you've built something great, [send us feat == Installation == -**WP LCache requires PHP 5.6 or greater with the APCu module enabled.** If you're running an older PHP version, or 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. To install WP LCache, follow these steps: From 1637e8547470e7cf243085d873b49b5e6171d103 Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Wed, 7 Sep 2016 17:03:35 -0700 Subject: [PATCH 3/4] Update release date --- README.md | 2 +- readme.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c081b06..8fc7488 100644 --- a/README.md +++ b/README.md @@ -59,5 +59,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. diff --git a/readme.txt b/readme.txt index eeb5db1..6d3e30e 100644 --- a/readme.txt +++ b/readme.txt @@ -59,5 +59,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. From 7ce24dcee48fcc0baac71f18541b50ae69d4cb8f Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Wed, 7 Sep 2016 17:06:53 -0700 Subject: [PATCH 4/4] Mention `composer install` step --- README.md | 1 + readme.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 8fc7488..64804a9 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Go forth and make awesome! And, once you've built something great, [send us feat To install WP LCache, follow these steps: 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` diff --git a/readme.txt b/readme.txt index 6d3e30e..25851e9 100644 --- a/readme.txt +++ b/readme.txt @@ -28,6 +28,7 @@ Go forth and make awesome! And, once you've built something great, [send us feat To install WP LCache, follow these steps: 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`