monorepo/native/wordpress/maple-performance-wp/readme.txt
2026-02-02 12:35:28 -05:00

142 lines
6 KiB
Text

=== Maple Performance WP ===
Contributors: mapleopentech
Tags: cache, performance, speed, optimization, minify
Requires at least: 5.9
Tested up to: 6.4
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
A lightweight, privacy-focused WordPress performance plugin. No external dependencies, no tracking, no upsells.
== Description ==
Maple Performance WP is a Canadian-made, privacy-focused performance optimization plugin that speeds up your WordPress site without sending any data to external servers.
**Key Features:**
* **Page Caching** - Creates static HTML files with optional Gzip/Brotli pre-compression
* **HTML Minification** - Removes unnecessary whitespace and comments
* **CSS Optimization** - Minify and aggregate CSS files
* **JavaScript Optimization** - Minify and aggregate JS files (with safe defaults)
* **Google Fonts Optimization** - Combine, add display:swap, and optionally defer loading
* **Lazy Loading** - Native lazy loading for images and iframes
* **Extra Optimizations** - Remove emoji scripts, query strings, add preconnect hints
* **Smart Plugin Compatibility** - Auto-detects WooCommerce, LearnDash, WPForms, Wordfence and applies safe exclusions
**Site Mode Presets:**
Choose your site type and Maple Performance automatically applies safe default settings:
* **Brochure/Blog** - Full optimization enabled
* **WooCommerce** - Conservative JS settings to protect checkout
* **LearnDash** - Safe settings to protect lesson tracking and quizzes
* **WooCommerce + LearnDash** - Maximum safety for course selling sites
**Privacy First:**
* No external API calls
* No tracking or analytics
* No CDN dependencies
* No upsells or premium nags
* All processing happens on your server
**Canadian Data Sovereignty:**
Built by [Maple Open Tech](https://mapleopentech.ca) for Canadian businesses who care about keeping their data in Canada.
== Installation ==
1. Upload the `maple-performance-wp` folder to `/wp-content/plugins/`
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Go to Settings > Maple Performance
4. Select your site type (Brochure, WooCommerce, LearnDash, or both)
5. Adjust settings as needed
6. Save and test your site
== Frequently Asked Questions ==
= Is this safe for WooCommerce? =
Yes! Select "WooCommerce Store" as your site type and Maple Performance automatically disables aggressive optimizations that could break checkout. Cart and checkout pages are excluded from caching automatically.
= Is this safe for LearnDash? =
Yes! Select "LearnDash LMS" as your site type and JavaScript aggregation is disabled to protect lesson completion tracking and quiz functionality.
= Does this require any external service? =
No. Everything runs on your server. No API calls, no CDN requirements, no external dependencies.
= How do I clear the cache? =
Click "Clear All Cache" in the admin bar, or go to Settings > Maple Performance and click the clear cache button.
= Can I use this with other caching plugins? =
Not recommended. Deactivate other caching plugins (W3 Total Cache, WP Rocket, LiteSpeed Cache, etc.) before activating Maple Performance to avoid conflicts.
= What plugins are automatically compatible? =
Maple Performance automatically detects and applies safe defaults for:
* **WooCommerce** - Cart, checkout, account pages excluded from cache. Cart/checkout scripts protected.
* **LearnDash** - Lesson, topic, quiz pages excluded. Progress tracking and quiz scripts protected.
* **WPForms** - Form scripts excluded from aggregation. AJAX submissions protected.
* **Wordfence** - Security scripts excluded. Login pages not cached. Firewall cookies respected.
* **Gravity Forms** - Form scripts excluded from aggregation.
* **Contact Form 7** - Form scripts excluded from aggregation.
* **Elementor** - Builder scripts excluded from aggregation.
You'll see a list of detected plugins and applied protections on the settings page.
= Is Maple Performance GDPR compliant? =
Yes. Maple Performance WP is designed with privacy in mind:
* **No personal data collection** - The plugin does not collect, store, or process any personal data such as IP addresses, email addresses, names, or user identifiers.
* **No cookies set** - The plugin does not set any cookies. It only reads existing cookies (like WordPress login or WooCommerce cart cookies) to determine whether to serve cached content.
* **No external connections** - The plugin does not connect to any external services or transmit any data to third parties. All processing happens locally on your server.
* **No tracking or analytics** - There is no usage tracking, telemetry, or analytics of any kind.
* **Logged-in users excluded** - By default, pages are not cached for logged-in users, ensuring no user-specific content is stored.
The plugin automatically adds suggested text to your Privacy Policy page (Settings → Privacy) explaining its data practices.
= What data does the cache store? =
The cache stores only:
1. **Static HTML files** - Copies of your publicly-visible pages (the same content any visitor would see)
2. **Aggregated CSS/JS files** - Combined and minified versions of your theme/plugin assets
No personal data, user information, or tracking data is ever stored in the cache.
= What PageSpeed scores can I expect? =
* Brochure sites: 80-95
* WooCommerce sites: 70-85
* LearnDash sites: 70-85
* WooCommerce + LearnDash: 65-80
The conservative settings for ecommerce and LMS sites prioritize functionality over scores.
== Changelog ==
= 1.0.0 =
* Initial release
* Page caching with Gzip/Brotli support
* HTML, CSS, and JS minification
* CSS and JS aggregation
* Google Fonts optimization (combine, display:swap, defer)
* Lazy loading for images and iframes
* Site mode presets for WooCommerce and LearnDash
* Automatic plugin compatibility for WooCommerce, LearnDash, WPForms, Wordfence, Gravity Forms, Contact Form 7, Elementor
* DNS prefetch and preconnect support
* Emoji removal
* Query string removal
== Upgrade Notice ==
= 1.0.0 =
Initial release of Maple Performance WP.