readme fix

git-svn-id: http://plugins.svn.wordpress.org/wp-ffpc/trunk@505974 b8457f37-d9ea-0310-8a92-e5e31aec5664
This commit is contained in:
cadeyrn 2012-02-16 14:41:02 +00:00
parent 7d9d1acf32
commit 745643bc47

View file

@ -7,36 +7,40 @@ Stable tag: 0.1
Fast Full Page Cache, backend can be memcached or APC
== Description ==
WP-FFPC is a full page cache plugin for WordPress. It can use APC or a memcached server as backend.
WP-FFPC is a full page cache plugin for WordPress. It can use APC or a memcached server as backend. The naming stands for Fast Full Page Cache.
PHP has two extension for communication with a memcached server, named Memcache and Memcached. The plugin can utilize both.
PHP has two extension for communication with a memcached server, named Memcache and Memcached. The plugin can utilize both.
A special function is that when used with the Memcache extension it produces memcached entries that can be read and served directly from nginx, making the cache insanely fast.
= Features: =
* exclude possibility of home, feeds, archieves, pages, singles
* use APC or memcached as backend
* 404 caching
* redirects caching
* Last Modified HTTP header compatibility with 304 responses
* shortlink HTTP header preservation
* pingback HTTP header preservation(1)
* fallback to no caching if any error or problem occurs
* Wordpress Network compatible(2)
* nginx compatible(3)
The naming stands for Fast Full Page Cache.
If used in WordPress Network, the configuration will only be available for network admins at the network admin panel, and will be system-wide and will be applied for every blog.
Some parts were based on [Hyper Cache](http://wordpress.org/extend/plugins/hyper-cache "Hyper Cache") plugin by Satollo (info@satollo.net).
(1) pingback hostname will always be generated from the accessed domain, otherwise speed would get highly compromised
(2) If used in WordPress Network, the configuration will only be available for network admins at the network admin panel, and will be system-wide and will be applied for every blog.
(3) nginx compatility means that if used with PHP Memcache (not Memcached!) extension, the created memcached entries that can be read and served directly from nginx, making the cache insanely fast. If used with APC or Memcached, this feature is not available (no APC module for nginx, compression incompatibility with Memcached), although, naturally, the cache modul is functional and working, but it will be done by PHP instead of nginx.
Short nginx example configuration is generated on the plugin settings page if Memcache is selected as cache type.
Some parts were based on [Hyper Cache](http://wordpress.org/extend/plugins/hyper-cache "Hyper Cache") plugin by Satollo (info@satollo.net).
== Installation ==
1. Upload contents of `wp-ffpc.zip` to the `/wp-content/plugins/` directory
2. Enable WordPress cache by adding `define('WP_CACHE',true);` in wp-config.php
3. Activate the plugin through the `Plugins` menu in WordPress (please use network wide activation if used in a WordPress Network)
4. Fine tune the settings in `Settings` -> `wp-ffpc` menu in WordPress. For WordPress Network, please visit the Network Admin panel, the options will be available at WP-FFPC menu entry.
3. Activate the plugin through the `Plugins` menu in WordPress (please use network wide activation if used in a WordPress Network)
4. Fine tune the settings in `Settings` -> `wp-ffpc` menu in WordPress. For WordPress Network, please visit the Network Admin panel, the options will be available at WP-FFPC menu entry.
== Frequently Asked Questions ==
== Screenshots ==
== Upgrade Notice ==
== Changelog ==
= 0.1 =