Ryan Malloy
524e2f0e5e
Two clearly-labeled install methods at the top of the README so users know how to get the plugin without scrolling: - WordPress Admin GUI: 3-step ZIP upload - WP-CLI one-liner with --activate flag Both link directly to the v1.0.0 release ZIP on Gitea.
247 lines
7.0 KiB
Markdown
247 lines
7.0 KiB
Markdown
# ⚡ TigerStyle Dash
|
|
|
|
**WordPress Performance at Lightning Speed**
|
|
|
|
*Dash past the competition with advanced Brotli compression, smart caching, and cat-like reflexes that make your website load faster than you can blink.*
|
|
|
|
---
|
|
|
|
## 📦 Installation
|
|
|
|
**Latest release:** [v1.0.0](https://git.supported.systems/tigerstyle/tigerstyle-dash/releases/tag/v1.0.0) · [All releases](https://git.supported.systems/tigerstyle/tigerstyle-dash/releases)
|
|
|
|
### Via WordPress Admin (GUI)
|
|
|
|
1. Download [tigerstyle-dash-1.0.0.zip](https://git.supported.systems/tigerstyle/tigerstyle-dash/releases/download/v1.0.0/tigerstyle-dash-1.0.0.zip)
|
|
2. In WordPress admin: **Plugins → Add New → Upload Plugin**, pick the ZIP
|
|
3. Click **Activate Plugin** — settings appear under **TigerStyle Dash** in the sidebar
|
|
|
|
### Via WP-CLI (terminal)
|
|
|
|
```bash
|
|
wp plugin install \
|
|
https://git.supported.systems/tigerstyle/tigerstyle-dash/releases/download/v1.0.0/tigerstyle-dash-1.0.0.zip \
|
|
--activate
|
|
```
|
|
|
|
**Requires:** WordPress 5.0+ · PHP 7.4+
|
|
|
|
---
|
|
|
|
## 🏃♀️ Why TigerStyle Dash?
|
|
|
|
**Because your website should be as fast as a cat's reflexes!**
|
|
|
|
TigerStyle Dash delivers **enterprise-grade performance optimization** with the simplicity your development workflow deserves. No complex configurations, no bloated interfaces - just lightning-fast results.
|
|
|
|
### ⚡ **Key Features**
|
|
|
|
- **🚀 Advanced Compression**: Brotli + Gzip fallbacks with automatic method selection
|
|
- **🧠 Smart Caching**: Intelligent cache warming and purging
|
|
- **📊 Performance Analytics**: Real-time metrics and optimization scoring
|
|
- **🎯 Core Web Vitals**: Optimize for Google's ranking factors
|
|
- **💾 Massive Savings**: Reduce file sizes by 60-80%
|
|
- **🔧 WP Rocket-Inspired**: Modern compression techniques, simplified
|
|
|
|
---
|
|
|
|
## 📈 **Performance Impact**
|
|
|
|
```
|
|
Before TigerStyle Dash:
|
|
📄 HTML: 125KB → ⚡ After: 31KB (75% reduction)
|
|
🎨 CSS: 89KB → ⚡ After: 22KB (75% reduction)
|
|
📜 JS: 156KB → ⚡ After: 47KB (70% reduction)
|
|
|
|
🎯 Core Web Vitals: Significant LCP and FCP improvements
|
|
💰 Bandwidth Costs: Reduced by up to 80%
|
|
🏆 Google Rankings: Better performance = higher SEO scores
|
|
```
|
|
|
|
---
|
|
|
|
## 🚀 **Quick Start**
|
|
|
|
### Installation
|
|
|
|
1. **Copy plugin to WordPress**:
|
|
```bash
|
|
cp -r src/tigerstyle-dash wp-content/plugins/
|
|
```
|
|
|
|
2. **Activate in WordPress Admin**:
|
|
- Go to `Plugins → Installed Plugins`
|
|
- Find "TigerStyle Dash"
|
|
- Click **Activate**
|
|
|
|
3. **Configure settings**:
|
|
- Navigate to `Dash Performance` in admin menu
|
|
- Enable compression and smart caching
|
|
- **Done!** Your site is now lightning-fast ⚡
|
|
|
|
### Basic Configuration
|
|
|
|
```php
|
|
// Default settings (recommended for most sites)
|
|
Compression: Auto (Brotli + Gzip fallback)
|
|
Level: 6 (optimal balance)
|
|
Cache: Enabled
|
|
TTL: 3600 seconds (1 hour)
|
|
```
|
|
|
|
---
|
|
|
|
## 🛠️ **Advanced Configuration**
|
|
|
|
### Compression Methods
|
|
|
|
| Method | Best For | Compression Ratio | Speed |
|
|
|--------|----------|-------------------|-------|
|
|
| **Auto** ✅ | Most sites | 70-75% | Fast |
|
|
| **Brotli** | Modern browsers | 75-80% | Fast |
|
|
| **Gzip** | Legacy support | 65-70% | Fastest |
|
|
|
|
### Cache Strategy
|
|
|
|
- **Smart Warming**: Pre-compresses popular content
|
|
- **Intelligent Purging**: Clears cache on content updates
|
|
- **Analytics Integration**: Tracks performance improvements
|
|
|
|
---
|
|
|
|
## 🔧 **Developer API**
|
|
|
|
### Programmatic Access
|
|
|
|
```php
|
|
// Get Dash instance
|
|
$dash = tigerstyle_dash();
|
|
|
|
// Manual compression
|
|
$result = TigerStyle_Dash_Compression::compress($content, 'auto', 6);
|
|
|
|
// Cache operations
|
|
$cache = $dash->get_cache();
|
|
$cache->store('key', $content, 'brotli');
|
|
|
|
// Performance analytics
|
|
$analytics = $dash->get_analytics();
|
|
$score = $analytics->analyze_site_performance();
|
|
```
|
|
|
|
### Hooks & Filters
|
|
|
|
```php
|
|
// Customize compression settings
|
|
add_filter('tigerstyle_dash_compression_level', function($level) {
|
|
return 8; // Higher compression
|
|
});
|
|
|
|
// Skip compression for specific content
|
|
add_filter('tigerstyle_dash_should_compress', function($should_compress, $content) {
|
|
// Your custom logic
|
|
return $should_compress;
|
|
}, 10, 2);
|
|
```
|
|
|
|
---
|
|
|
|
## 📊 **Performance Monitoring**
|
|
|
|
### Built-in Analytics Dashboard
|
|
|
|
- **Real-time Statistics**: Files compressed, bandwidth saved
|
|
- **Performance Score**: A+ to F grading system
|
|
- **Optimization Recommendations**: Actionable improvements
|
|
- **Core Web Vitals Tracking**: Monitor Google ranking factors
|
|
|
|
### Integration with Popular Tools
|
|
|
|
- **Google PageSpeed Insights**: Improved scores
|
|
- **GTmetrix**: Better performance grades
|
|
- **WebPageTest**: Faster load times
|
|
- **Search Console**: Core Web Vitals reporting
|
|
|
|
---
|
|
|
|
## 🎯 **Optimization Recommendations**
|
|
|
|
### Automatic Analysis
|
|
|
|
TigerStyle Dash analyzes your site and provides **prioritized recommendations**:
|
|
|
|
- **High Priority**: Enable compression, activate caching
|
|
- **Medium Priority**: Optimize compression method
|
|
- **Low Priority**: Fine-tune compression levels
|
|
|
|
### Performance Scoring
|
|
|
|
```
|
|
A+ (90-100%): Lightning fast! 🏆
|
|
A (80-89%): Excellent performance ⚡
|
|
B (70-79%): Good, room for improvement 👍
|
|
C (60-69%): Average, needs optimization ⚠️
|
|
D (50-59%): Slow, requires attention 🐌
|
|
F (0-49%): Critical performance issues 🚨
|
|
```
|
|
|
|
---
|
|
|
|
## 🐾 **TigerStyle Ecosystem**
|
|
|
|
TigerStyle Dash is part of the **TigerStyle WordPress Plugin Suite**:
|
|
|
|
- **🔍 TigerStyle Heat**: Comprehensive SEO optimization
|
|
- **🔒 TigerStyle Life9**: Secure backup & restore
|
|
- **⚡ TigerStyle Dash**: Performance optimization (this plugin)
|
|
- **🎯 TigerStyle Pounce**: *Coming soon - Security monitoring*
|
|
|
|
*Each plugin excels in its specialized domain while working seamlessly together.*
|
|
|
|
---
|
|
|
|
## 🛟 **Support & Development**
|
|
|
|
### System Requirements
|
|
|
|
- **WordPress**: 5.0+
|
|
- **PHP**: 7.4+
|
|
- **Extensions**: `zlib`, `json` (standard in most hosting)
|
|
- **Optional**: `brotli` extension for maximum compression
|
|
|
|
### Browser Compatibility
|
|
|
|
- **Brotli**: Chrome 50+, Firefox 44+, Safari 11+
|
|
- **Gzip**: Universal support (automatic fallback)
|
|
- **Smart Detection**: Automatically serves best format per browser
|
|
|
|
### Performance Tips
|
|
|
|
1. **Level 6 compression**: Best balance of speed vs. size
|
|
2. **Auto method**: Maximizes browser compatibility
|
|
3. **1-hour cache TTL**: Optimal for most content update frequencies
|
|
4. **Monitor analytics**: Use built-in dashboard for optimization
|
|
|
|
---
|
|
|
|
## 🚀 **Roadmap**
|
|
|
|
### Upcoming Features
|
|
|
|
- **Image Optimization**: WebP conversion, lazy loading
|
|
- **CDN Integration**: Automatic CDN setup and management
|
|
- **Database Optimization**: Query caching, table cleanup
|
|
- **Critical CSS**: Above-the-fold optimization
|
|
- **HTTP/3 Support**: Latest protocol optimizations
|
|
|
|
---
|
|
|
|
## 💡 **Fun Facts**
|
|
|
|
- **Cat Reflexes**: Cats react in 20-70ms - that's our target for cache response times!
|
|
- **Speed Inspiration**: Just like cats can dash at 30mph in short bursts, your site gets speed bursts when needed
|
|
- **"Dash past the competition"**: More than a tagline - it's a performance promise
|
|
|
|
---
|
|
|
|
*Built with 🐾 by the TigerStyle team. Making WordPress faster, one dash at a time.* |