mirror of
https://github.com/cloud-shuttle/leptos-shadcn-ui.git
synced 2025-12-22 22:00:00 +00:00
docs: Update documentation for v0.5.0 Performance Audit Edition
- Update README.md with performance audit features and v0.5.0 release info - Add comprehensive performance audit documentation - Create quick start guide for performance monitoring - Update documentation index with performance audit section - Include installation instructions and usage examples - Add component listing with current versions - Update testing section with performance audit tests
This commit is contained in:
Peter Hanssens
191
README.md
191
README.md
@@ -7,6 +7,7 @@
|
||||
[](LICENSE)
|
||||
[](docs/tdd/completion/TDD_COMPLETION_SUMMARY.md)
|
||||
[](tests/e2e)
|
||||
[](performance-audit)
|
||||
|
||||
## 🏆 **Project Status: 100% TDD Implementation Complete!**
|
||||
|
||||
@@ -18,6 +19,31 @@
|
||||
- ✅ **Documentation**: Comprehensive guides and examples
|
||||
- ✅ **Performance Audit**: Complete TDD performance monitoring system
|
||||
|
||||
## 🎉 **Latest Release: v0.5.0 - Performance Audit Edition**
|
||||
|
||||
### **What's New in v0.5.0**
|
||||
- ✨ **Performance Audit System** - Complete TDD implementation with 53 tests
|
||||
- 📊 **Bundle Size Analysis** - Component optimization recommendations
|
||||
- ⚡ **Real-time Performance Monitoring** - Render time and memory tracking
|
||||
- 🗺️ **Optimization Roadmap** - Smart recommendations with ROI estimates
|
||||
- 🛠️ **CLI Tool** - Professional command-line interface
|
||||
- 📈 **Benchmarking Suite** - Performance regression testing
|
||||
|
||||
### **Quick Start with v0.5.0**
|
||||
```bash
|
||||
# Install the performance audit tool
|
||||
cargo install leptos-shadcn-performance-audit
|
||||
|
||||
# Use the main package with performance monitoring
|
||||
cargo add leptos-shadcn-ui --features performance-audit
|
||||
|
||||
# Run your first performance audit
|
||||
performance-audit audit
|
||||
```
|
||||
|
||||
### **Release Notes**
|
||||
- **[v0.5.0 Release Notes](RELEASE_NOTES_v0.5.0.md)** - Comprehensive release information
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **What This Is**
|
||||
@@ -35,17 +61,34 @@
|
||||
|
||||
### **Installation**
|
||||
|
||||
Add components to your `Cargo.toml`:
|
||||
#### **Option 1: Individual Components (Recommended)**
|
||||
Add specific components to your `Cargo.toml`:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
leptos-shadcn-button = "0.2.0"
|
||||
leptos-shadcn-input = "0.2.0"
|
||||
leptos-shadcn-card = "0.2.0"
|
||||
leptos-shadcn-checkbox = "0.2.0"
|
||||
leptos-shadcn-button = "0.4.0"
|
||||
leptos-shadcn-input = "0.4.0"
|
||||
leptos-shadcn-card = "0.4.0"
|
||||
leptos-shadcn-checkbox = "0.4.0"
|
||||
# ... add more components as needed
|
||||
```
|
||||
|
||||
#### **Option 2: Main Package with Features**
|
||||
Use the main package with feature flags:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
leptos-shadcn-ui = { version = "0.5.0", features = ["button", "input", "card", "checkbox"] }
|
||||
```
|
||||
|
||||
#### **Option 3: With Performance Monitoring**
|
||||
Include the performance audit system:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
leptos-shadcn-ui = { version = "0.5.0", features = ["button", "input", "performance-audit"] }
|
||||
```
|
||||
|
||||
### **Basic Usage**
|
||||
|
||||
```rust
|
||||
@@ -68,18 +111,62 @@ pub fn MyForm() -> impl IntoView {
|
||||
|
||||
Monitor and optimize your component performance with the built-in audit system:
|
||||
|
||||
#### **Install Performance Audit Tool**
|
||||
```bash
|
||||
# Install the performance audit tool
|
||||
cargo install leptos-shadcn-performance-audit
|
||||
```
|
||||
|
||||
# Run comprehensive performance audit
|
||||
#### **Run Performance Audits**
|
||||
```bash
|
||||
# Complete performance audit
|
||||
performance-audit audit
|
||||
|
||||
# Analyze bundle sizes
|
||||
# Analyze bundle sizes only
|
||||
performance-audit bundle --components-path packages/leptos
|
||||
|
||||
# Monitor real-time performance
|
||||
performance-audit monitor --duration 30s
|
||||
performance-audit monitor --duration 30s --sample-rate 100ms
|
||||
|
||||
# Generate optimization roadmap
|
||||
performance-audit roadmap --output roadmap.json --format json
|
||||
```
|
||||
|
||||
#### **Performance Audit Features**
|
||||
- **📊 Bundle Size Analysis** - Track component sizes and identify optimization opportunities
|
||||
- **⚡ Real-time Monitoring** - Monitor render times and memory usage
|
||||
- **🗺️ Optimization Roadmap** - Get actionable recommendations with ROI estimates
|
||||
- **📈 Benchmarking** - Performance regression testing and comparison
|
||||
- **🛠️ CLI Tool** - Professional command-line interface with multiple output formats
|
||||
|
||||
#### **Example Output**
|
||||
```
|
||||
🔍 Running comprehensive performance audit...
|
||||
📊 Configuration:
|
||||
Max Component Size: 5.0 KB
|
||||
Max Render Time: 16.0 ms
|
||||
Max Memory Usage: 1.0 MB
|
||||
Output Format: Text
|
||||
|
||||
⏳ Analyzing components...
|
||||
✅ Analysis complete!
|
||||
|
||||
📊 Performance Audit Results
|
||||
Overall Score: 64.0/100 (D)
|
||||
Meets Targets: ❌ No
|
||||
|
||||
📦 Bundle Analysis:
|
||||
Overall Efficiency: 44.6%
|
||||
Total Size: 23.0 KB
|
||||
Average Component Size: 4.6 KB
|
||||
|
||||
⚡ Performance Monitoring:
|
||||
Overall Score: 83.3%
|
||||
Failing Components: 2
|
||||
|
||||
🗺️ Optimization Roadmap:
|
||||
Total Recommendations: 6
|
||||
Estimated Effort: 40.0 hours
|
||||
Expected Impact: 470.0%
|
||||
```
|
||||
|
||||
### **Run Examples**
|
||||
@@ -96,6 +183,73 @@ trunk serve
|
||||
|
||||
---
|
||||
|
||||
## 📦 **Available Components**
|
||||
|
||||
### **Form Components**
|
||||
- **Button** - `leptos-shadcn-button v0.4.0`
|
||||
- **Input** - `leptos-shadcn-input v0.4.0`
|
||||
- **Label** - `leptos-shadcn-label v0.4.0`
|
||||
- **Checkbox** - `leptos-shadcn-checkbox v0.4.0`
|
||||
- **Switch** - `leptos-shadcn-switch v0.4.0`
|
||||
- **Radio Group** - `leptos-shadcn-radio-group v0.4.0`
|
||||
- **Select** - `leptos-shadcn-select v0.4.0`
|
||||
- **Textarea** - `leptos-shadcn-textarea v0.4.0`
|
||||
- **Form** - `leptos-shadcn-form v0.4.0`
|
||||
- **Combobox** - `leptos-shadcn-combobox v0.4.0`
|
||||
- **Command** - `leptos-shadcn-command v0.4.0`
|
||||
- **Input OTP** - `leptos-shadcn-input-otp v0.4.0`
|
||||
|
||||
### **Layout Components**
|
||||
- **Card** - `leptos-shadcn-card v0.4.0`
|
||||
- **Separator** - `leptos-shadcn-separator v0.4.0`
|
||||
- **Tabs** - `leptos-shadcn-tabs v0.4.0`
|
||||
- **Accordion** - `leptos-shadcn-accordion v0.4.0`
|
||||
- **Collapsible** - `leptos-shadcn-collapsible v0.4.0`
|
||||
- **Scroll Area** - `leptos-shadcn-scroll-area v0.4.0`
|
||||
- **Aspect Ratio** - `leptos-shadcn-aspect-ratio v0.4.0`
|
||||
- **Resizable** - `leptos-shadcn-resizable v0.4.0`
|
||||
|
||||
### **Overlay Components**
|
||||
- **Dialog** - `leptos-shadcn-dialog v0.4.0`
|
||||
- **Popover** - `leptos-shadcn-popover v0.4.0`
|
||||
- **Tooltip** - `leptos-shadcn-tooltip v0.4.0`
|
||||
- **Alert Dialog** - `leptos-shadcn-alert-dialog v0.4.0`
|
||||
- **Sheet** - `leptos-shadcn-sheet v0.4.0`
|
||||
- **Drawer** - `leptos-shadcn-drawer v0.4.0`
|
||||
- **Hover Card** - `leptos-shadcn-hover-card v0.4.0`
|
||||
|
||||
### **Navigation Components**
|
||||
- **Breadcrumb** - `leptos-shadcn-breadcrumb v0.4.0`
|
||||
- **Navigation Menu** - `leptos-shadcn-navigation-menu v0.4.0`
|
||||
- **Context Menu** - `leptos-shadcn-context-menu v0.4.0`
|
||||
- **Dropdown Menu** - `leptos-shadcn-dropdown-menu v0.4.0`
|
||||
- **Menubar** - `leptos-shadcn-menubar v0.4.0`
|
||||
|
||||
### **Feedback & Status**
|
||||
- **Alert** - `leptos-shadcn-alert v0.4.0`
|
||||
- **Badge** - `leptos-shadcn-badge v0.4.0`
|
||||
- **Skeleton** - `leptos-shadcn-skeleton v0.4.0`
|
||||
- **Progress** - `leptos-shadcn-progress v0.4.0`
|
||||
- **Toast** - `leptos-shadcn-toast v0.4.0`
|
||||
- **Table** - `leptos-shadcn-table v0.4.0`
|
||||
- **Calendar** - `leptos-shadcn-calendar v0.4.0`
|
||||
- **Date Picker** - `leptos-shadcn-date-picker v0.4.0`
|
||||
- **Pagination** - `leptos-shadcn-pagination v0.4.0`
|
||||
|
||||
### **Interactive Components**
|
||||
- **Slider** - `leptos-shadcn-slider v0.4.0`
|
||||
- **Toggle** - `leptos-shadcn-toggle v0.4.0`
|
||||
- **Carousel** - `leptos-shadcn-carousel v0.4.0`
|
||||
- **Avatar** - `leptos-shadcn-avatar v0.4.0`
|
||||
|
||||
### **Performance & Development**
|
||||
- **Performance Audit** - `leptos-shadcn-performance-audit v0.1.0` ⭐ **NEW!**
|
||||
- **Error Boundary** - `leptos-shadcn-error-boundary v0.4.0`
|
||||
- **Lazy Loading** - `leptos-shadcn-lazy-loading v0.4.0`
|
||||
- **Registry** - `leptos-shadcn-registry v0.1.0`
|
||||
|
||||
---
|
||||
|
||||
## 🧪 **Testing & Quality**
|
||||
|
||||
### **Run Unit Tests**
|
||||
@@ -105,10 +259,29 @@ trunk serve
|
||||
cargo test --package leptos-shadcn-button --lib
|
||||
cargo test --package leptos-shadcn-input --lib
|
||||
|
||||
# Test performance audit system
|
||||
cargo test -p leptos-shadcn-performance-audit
|
||||
|
||||
# Test all components
|
||||
cargo test --workspace
|
||||
```
|
||||
|
||||
### **Performance Audit Testing**
|
||||
|
||||
The performance audit system includes comprehensive testing:
|
||||
|
||||
```bash
|
||||
# Run all performance audit tests (53 tests)
|
||||
cargo test -p leptos-shadcn-performance-audit
|
||||
|
||||
# Run specific test suites
|
||||
cargo test -p leptos-shadcn-performance-audit --lib
|
||||
cargo test -p leptos-shadcn-performance-audit --test performance_audit_tests
|
||||
|
||||
# Test CLI tool
|
||||
cargo run -p leptos-shadcn-performance-audit --bin performance-audit -- --help
|
||||
```
|
||||
|
||||
### **Run E2E Tests**
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user