Skip to content

Commit 1f57582

Browse files
authored
Update README.md
1 parent d5e7598 commit 1f57582

File tree

1 file changed

+2
-153
lines changed

1 file changed

+2
-153
lines changed

README.md

Lines changed: 2 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -99,21 +99,10 @@ WP Performance is a comprehensive must-use plugin that:
9999

100100
## Installation
101101

102-
### Via Composer (Recommended)
103-
104102
```bash
105103
composer require jazzman/wp-performance
106104
```
107105

108-
The package installs to `wp-content/mu-plugins/wp-performance/` automatically.
109-
110-
### Manual Installation
111-
112-
1. Download the latest release
113-
2. Upload to `wp-content/mu-plugins/wp-performance/`
114-
3. Ensure `wp-performance.php` is in the mu-plugins root
115-
4. Plugin activates automatically
116-
117106
## Dependencies
118107

119108
This package is part of the **jazzman WordPress ecosystem** and depends on:
@@ -126,43 +115,7 @@ All dependencies are installed automatically via Composer.
126115

127116
## Configuration
128117

129-
### Zero Configuration
130-
131-
The plugin works out-of-the-box with sensible defaults for most sites.
132-
133-
### Advanced Configuration
134-
135-
For fine-grained control, use WordPress filters:
136-
137-
```php
138-
// Customize which features to disable
139-
add_filter('wp_performance_disable_emojis', '__return_false'); // Keep emojis
140-
add_filter('wp_performance_disable_xmlrpc', '__return_true'); // Disable XML-RPC
141-
142-
// Media optimization
143-
add_filter('wp_performance_disable_image_sizes', function() {
144-
return ['medium_large', 'large']; // Disable specific sizes
145-
});
146-
147-
// Update check intervals
148-
add_filter('wp_performance_update_check_interval', function() {
149-
return 24; // Check once per day (default: never)
150-
});
151-
```
152-
153-
## Performance Impact
154-
155-
Real-world metrics from production sites:
156-
157-
| Metric | Before | After | Improvement |
158-
|--------|--------|-------|-------------|
159-
| **HTTP Requests** | 45 | 22 | 51% reduction |
160-
| **Page Load Time** | 3.2s | 1.8s | 44% faster |
161-
| **Database Queries** | 87 | 52 | 40% fewer queries |
162-
| **Memory Usage** | 42MB | 28MB | 33% reduction |
163-
| **TTFB** | 850ms | 480ms | 43% faster |
164-
165-
*Metrics vary based on site configuration and hosting.*
118+
The plugin works out-of-the-box with sensible defaults for most sites. No configuration needed.
166119

167120
## Architecture
168121

@@ -185,34 +138,6 @@ src/
185138
└── Utils/ # Utility classes
186139
```
187140

188-
### Autoloading
189-
190-
PSR-4 autoloading with namespace `JazzMan\Performance`:
191-
192-
```php
193-
use JazzMan\Performance\Optimization\CleanUp;
194-
use JazzMan\Performance\Security\Sanitize;
195-
```
196-
197-
## Quality Standards
198-
199-
### Comprehensive Static Analysis
200-
201-
```bash
202-
# PHPStan (max level)
203-
composer phpstan
204-
205-
# Psalm (strict mode)
206-
composer psalm
207-
208-
# PHP Mess Detector
209-
composer phpmd
210-
211-
# Code style
212-
composer cs-check
213-
composer cs-fix
214-
```
215-
216141
### Quality Tools
217142

218143
-**PHPStan** (max level with baseline)
@@ -236,40 +161,6 @@ GitHub Actions workflows for:
236161
- **WordPress**: 6.0+
237162
- **Composer**: For installation and autoloading
238163

239-
## FAQ
240-
241-
**Q: Will this break my site?**
242-
A: No. The plugin only removes unnecessary features. If you need a disabled feature, it can be re-enabled via filters.
243-
244-
**Q: Is it compatible with caching plugins?**
245-
A: Yes. WP Performance works alongside WP Rocket, W3 Total Cache, WP Super Cache, and other caching solutions.
246-
247-
**Q: Does it work with page builders?**
248-
A: Yes. Compatible with Elementor, Beaver Builder, Divi, and other page builders.
249-
250-
**Q: Can I use it with other performance plugins?**
251-
A: Yes, but some features may overlap. Test carefully to avoid conflicts.
252-
253-
**Q: What about multisite?**
254-
A: Fully compatible. Install as network-wide must-use plugin.
255-
256-
**Q: Performance on shared hosting?**
257-
A: Works great on shared hosting. Reduced database queries = lower server load.
258-
259-
## Troubleshooting
260-
261-
**Issue: Features I need are disabled**
262-
**Solution:** Use filters to re-enable specific features (see Configuration section)
263-
264-
**Issue: Conflicts with another plugin**
265-
**Solution:** Disable specific modules via filters, or deactivate conflicting plugin
266-
267-
**Issue: Images not generating**
268-
**Solution:** Adjust `wp_performance_disable_image_sizes` filter
269-
270-
**Issue: Plugin updates not showing**
271-
**Solution:** Update checks are disabled by design. Use Composer or manual updates.
272-
273164
## Why This Plugin Exists
274165

275166
After years of WordPress development across hundreds of sites, I identified common performance bottlenecks:
@@ -290,31 +181,6 @@ Part of the **jazzman WordPress ecosystem**:
290181
- [`jazzman/wp-lscache`](https://github.com/Jazz-Man/wp-lscache) - LiteSpeed cache integration
291182
- [`jazzman/wp-geoip`](https://github.com/Jazz-Man/wp-geoip) - GeoIP functionality
292183

293-
## Benchmarks
294-
295-
Tested on a standard WordPress installation with WooCommerce:
296-
297-
### Query Reduction
298-
```
299-
Before: 287 queries in 0.45s
300-
After: 156 queries in 0.28s
301-
Result: 45% fewer queries, 38% faster
302-
```
303-
304-
### HTTP Request Reduction
305-
```
306-
Before: 52 HTTP requests
307-
After: 23 HTTP requests
308-
Result: 56% fewer requests
309-
```
310-
311-
### Memory Usage
312-
```
313-
Before: 48MB peak memory
314-
After: 31MB peak memory
315-
Result: 35% less memory
316-
```
317-
318184
## Contributing
319185

320186
Found a bug? Have a feature request? Contributions welcome!
@@ -326,21 +192,6 @@ Found a bug? Have a feature request? Contributions welcome!
326192
5. Push to branch (`git push origin feature/amazing`)
327193
6. Open Pull Request
328194

329-
## Security
330-
331-
**Security vulnerabilities:** Please email vsokolyk@gmail.com directly rather than opening a public issue.
332-
333-
## License
334-
335-
MIT License - see [LICENSE](LICENSE) file for details.
336-
337-
## Author
338-
339-
**Vasyl Sokolyk**
340-
- GitHub: [@Jazz-Man](https://github.com/Jazz-Man)
341-
- LinkedIn: [vasyl5](https://www.linkedin.com/in/vasyl5/)
342-
- Email: vsokolyk@gmail.com
343-
344195
---
345196

346197
## Support
@@ -349,8 +200,6 @@ MIT License - see [LICENSE](LICENSE) file for details.
349200

350201
💬 **Questions?** Open an issue on GitHub
351202

352-
🔧 **Need custom development?** Contact me directly
353-
354203
---
355204

356-
**Built with ❤️ for the WordPress community**
205+
**Built with ❤️ for the WordPress community**

0 commit comments

Comments
 (0)