Changeset 3435693

Timestamp:

01/09/2026 07:55:12 AM (3 months ago)

Author:

gkap186

Message:

Updated readme.txt: improved description, FAQ, fixed screenshots

File:

• varycache/trunk/readme.txt (modified) (5 diffs)

varycache/trunk/readme.txt

@@ -9 +9 @@
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
-Advanced variant-based caching system for A/B testing, geo-targeting, and query parameter variations. Serve different cached versions of pages.
+Advanced caching plugin with A/B testing, geo-targeting, query parameter variations, and speed optimizations. Serve different cached versions of pages.
 
 == Description ==
 
-VaryCache is a powerful caching plugin that allows you to serve different versions of cached pages based on various conditions:
-
-= Key Features =
-
-* **A/B Testing** - Create multiple A/B tests with weighted variants
-* **Geo Targeting** - Serve different content based on visitor's country
-* **Query Parameters** - Cache variations based on URL parameters (UTM, etc.)
-* **REST API Caching** - Cache REST API responses for improved performance
-* **Cache Preload** - Automatic and manual cache warming from sitemap
-* **Browser Cache Headers** - Cache-Control, Expires, Last-Modified headers
-* **Link Prefetch/Prerender** - Instant page navigation on hover (Speculation Rules API)
-* **Speed Optimizations** - HTML minification, DNS prefetch, preload hints
-* **Disable Emoji** - Remove WordPress emoji scripts to save bandwidth
-* **Remove Query Strings** - Remove ?ver= from static resources
+VaryCache is a powerful WordPress caching plugin that combines page caching with content personalization. Serve different cached versions of your pages based on A/B tests, visitor location, or URL parameters — all while maintaining excellent performance.
+
+= Core Caching =
+
+* **Page Cache** - File-based caching for fast page delivery without database overhead
+* **REST API Cache** - Cache REST API responses to reduce server load
+* **Cache Preload** - Automatic cache warming from sitemap
+* **Browser Cache Headers** - Cache-Control, Expires, Last-Modified, Vary headers
+
+= Content Personalization =
+
+* **A/B Testing** - Create multiple tests with weighted variants (50/50, 70/30, etc.)
+* **Geo Targeting** - Show different content based on visitor's country
+* **Query Parameters** - Cache variations based on UTM tags and other URL parameters
+
+= Speed Optimizations =
+
+* **HTML Minification** - Remove whitespace to reduce page size
+* **DNS Prefetch** - Pre-resolve external domains for faster loading
+* **Preload Resources** - Preload fonts, CSS, and hero images for better LCP
+* **Link Prefetch** - Preload pages on hover for instant navigation
+* **Disable Emoji** - Remove WordPress emoji scripts (~15KB savings)
+* **Remove Query Strings** - Better CDN caching for static resources
 * **Image Dimensions** - Auto-add missing width/height to prevent CLS
-* **File-based Caching** - Fast, lightweight caching without database overhead
+
+= Developer Features =
+
+* **Shortcodes** - Easy content switching in posts and pages
+* **PHP Functions** - Helper functions for theme developers
+* **Debug Panel** - Visual debugging panel on frontend
 * **CDN Compatible** - Works with CloudFront, Cloudflare, and other CDNs
-* **WP Rocket Integration** - Seamlessly integrates with WP Rocket caching
-* **Debug Panel** - Visual debugging panel for testing
-* **Shortcodes** - Easy content switching with shortcodes
-* **PHP Functions** - Helper functions for theme developers
+* **WP Rocket Integration** - Compatible with WP Rocket caching
 * **Multisite Support** - Full multisite compatibility
-
-= Use Cases =
-
-* Run A/B tests on landing pages
-* Show different pricing based on user's country
-* Personalize content for different traffic sources (UTM parameters)
-* Test different headlines, CTAs, or layouts
-* Serve localized content based on geo location
-
-= How It Works =
-
-1. Configure your tests, geo rules, or query parameters in the admin panel
-2. Add shortcodes to your pages or use PHP functions in your theme
-3. The plugin creates separate cached versions for each variant
-4. Visitors are automatically assigned variants based on your rules
 
 = Shortcodes =
@@ -60 +56 @@
 = PHP Functions =
 
-`if ( varycache_is_variant( 'A' ) ) {
+`// A/B Testing
+if ( varycache_is_variant( 'A' ) ) {
     // Show variant A content
-}`
-
-`if ( varycache_is_geo( 'US' ) ) {
+}
+$variant = varycache_get_variant(); // Returns 'A', 'B', etc.
+
+// Geo Targeting
+if ( varycache_is_geo( 'US' ) ) {
     // Show US-specific content
-}`
+}
+$country = varycache_get_geo(); // Returns 'US', 'RU', etc.`
 
 = Page Patterns =
 
 Flexible page matching with wildcards and regex:
+
 * `/` - Homepage only
-* `/blog/*` - Single segment wildcard
-* `/blog/**` - Any depth wildcard
-* `~^/post/\d+$` - Regular expression
+* `/pricing` - Exact page match
+* `/blog/*` - Single level wildcard
+* `/shop/**` - Any depth wildcard
+* `~^/post/\d+$` - Regular expression (prefix with ~)
 
 = Requirements =
@@ -88 +90 @@
 3. Go to Settings > VaryCache to configure
 
-= Basic Setup =
-
-1. Enable caching in the settings
-2. Create an A/B test or enable geo targeting
-3. Add pages where you want variant caching
-4. Use shortcodes in your content to show different versions
-
-= WP Rocket Integration =
-
-If using WP Rocket, exclude pages with variant caching from WP Rocket's cache:
+= Quick Start =
+
+1. Enable caching in the plugin settings
+2. Configure Page Cache to cache all pages or specific URLs
+3. Optionally set up A/B tests, geo targeting, or query parameters
+4. Use shortcodes in your content to show different versions to different visitors
+
+= Using with Other Cache Plugins =
+
+If using WP Rocket or another caching plugin, exclude pages with variant caching:
+
 1. Go to WP Rocket > Advanced Rules
-2. Add your test pages to "Never Cache URLs"
+2. Add your A/B test pages to "Never Cache URLs"
+
+VaryCache will handle caching for those pages with variant support.
 
 == Frequently Asked Questions ==
 
-= Does this work with page builders? =
-
-Yes! The shortcodes work with any page builder including Elementor, Gutenberg, Divi, and others.
-
-= How are visitors assigned to variants? =
-
-For A/B tests, visitors are randomly assigned based on configured weights and stored in a cookie. For geo targeting, the country is detected from HTTP headers (CloudFront-Viewer-Country, CF-IPCountry).
-
-= Does this affect SEO? =
-
-No. Search engines see the default variant and the canonical URL remains the same.
-
-= Can I run multiple A/B tests? =
-
-Yes! You can create multiple independent A/B tests with different pages and variants.
-
-= How long are variants cached? =
-
-You can configure the cache TTL (time to live) in settings. Default is 1 hour.
-
-= Does this work with CDNs? =
-
-Yes, but you need to configure your CDN to pass through cookies and country headers.
+= What makes VaryCache different from other caching plugins? =
+
+VaryCache combines page caching with content personalization. Unlike traditional caching plugins that serve the same cached page to everyone, VaryCache can serve different cached versions based on A/B tests, visitor location, or URL parameters.
+
+= Can I use VaryCache just for page caching without A/B testing? =
+
+Yes! You can use VaryCache purely as a page cache. Enable "General Page Cache" in the Page Cache tab and configure which pages to cache. A/B testing, geo targeting, and query parameters are optional features.
+
+= How does geo targeting detect the visitor's country? =
+
+VaryCache reads country information from HTTP headers provided by CDNs:
+- CloudFront: `CloudFront-Viewer-Country`
+- Cloudflare: `CF-IPCountry`
+- Custom: You can configure your own header name
+
+If no header is detected, the country code will be "XX".
+
+= Does this work with page builders like Elementor? =
+
+Yes! The shortcodes work with any page builder including Elementor, Gutenberg, Divi, WPBakery, and others. Simply add the shortcode blocks where needed.
+
+= How are visitors assigned to A/B test variants? =
+
+Visitors are randomly assigned based on the weights you configure (e.g., 50% variant A, 50% variant B). The assignment is stored in a cookie so they see the same variant on subsequent visits.
+
+= Does A/B testing affect SEO? =
+
+No. Search engine bots see the default variant, and the canonical URL remains unchanged. This is the recommended approach per Google's guidelines for A/B testing.
+
+= What are the speed optimization features? =
+
+VaryCache includes several Core Web Vitals optimizations:
+- **HTML Minification** - Reduces page size by removing whitespace
+- **DNS Prefetch** - Pre-resolves external domains (Google Fonts, Analytics, etc.)
+- **Preload Resources** - Preloads critical fonts, CSS, and hero images (improves LCP)
+- **Disable Emoji** - Removes WordPress emoji scripts (~15KB savings)
+- **Image Dimensions** - Adds missing width/height to prevent layout shifts (CLS)
+- **Link Prefetch** - Preloads pages when user hovers over links
+
+= How does REST API caching work? =
+
+You can configure specific REST API endpoints to be cached (e.g., `/wp/v2/posts`). Cached responses are served directly without executing PHP, significantly reducing server load for API-heavy sites.
+
+= Where are cache files stored? =
+
+Cache files are stored in `wp-content/cache/varycache/`. Settings are stored in `wp-content/uploads/varycache/settings.json`. Both locations are WordPress-compliant.
+
+= Can I clear the cache programmatically? =
+
+Yes, use `VaryCache_Cache::clear_cache()` in your code. The cache is also automatically cleared when posts are saved or deleted.
+
+= Does VaryCache work with CDNs? =
+
+Yes, but for A/B testing and geo targeting to work correctly, configure your CDN to:
+- Pass through cookies (for A/B test variant assignment)
+- Forward country headers (for geo targeting)
 
 == Screenshots ==
 
-1. A/B Tests configuration
-2. Geo targeting settings
-3. Query parameters configuration
-4. Cache report
-5. Debug panel on frontend
+1. VaryCache admin panel - flexible caching plugin for dynamic content
 
 == Changelog ==
 
 = 1.2.0 =
-* NEW: Speed optimization tab with performance features
+* NEW: Speed optimization tab with Core Web Vitals features
 * NEW: HTML Minification - reduce page size by removing whitespace
 * NEW: DNS Prefetch - pre-resolve external domains for faster loading
@@ -178 +212 @@
 
 = 1.2.0 =
-New Speed tab with Core Web Vitals optimizations: HTML minification, DNS prefetch, preload hints, disable emoji, image dimensions. Highly recommended.
+New Speed tab with Core Web Vitals optimizations: HTML minification, DNS prefetch, preload hints, disable emoji, image dimensions. Highly recommended update for better performance.
 
 = 1.1.0 =
@@ -185 +219 @@
 = 1.0.0 =
 Initial release.
-