Changeset 3436695

Timestamp:

01/10/2026 03:49:32 PM (3 weeks ago)

Author:

prakharb88

Message:

Improved readme.txt with comprehensive documentation matching other plugins

File:

• hungry-resource-monitor/trunk/readme.txt (modified) (5 diffs)

hungry-resource-monitor/trunk/readme.txt

@@ -1 +1 @@
 === Hungry Resource Monitor ===
 Contributors: prakharb88
+Donate link: https://nandann.com
 Tags: performance, memory, monitoring, optimization, cleanup
 Requires at least: 6.2
@@ -8 +9 @@
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
+Author: Prakhar Bhatia
+Author URI: https://nandann.com
 
 Monitor memory, CPU, and resource usage. Detect bloat from plugins, themes, and database. Weekly reports and optimization tips.
@@ -13 +16 @@
 == Description ==
 
-🧩 **What's Using My Memory?**
-
-Hungry Resource Monitor is a lightweight tool that tracks memory usage, database queries, and execution time across your WordPress site. Identify resource-heavy plugins and themes, clean up database bloat, and receive weekly performance reports.
+**Hungry Resource Monitor** is a lightweight yet powerful WordPress plugin that tracks memory usage, database queries, and execution time across your entire site. Identify resource-heavy plugins and themes, clean up database bloat, and receive configurable performance reports to keep your WordPress installation running smoothly.
 
 = Key Features =
 
-* **Dashboard** - View top 5 resource consumers at a glance
-* **Server Limits** - See PHP memory limits, execution time, and more
-* **Cleanup Tools** - Remove post revisions, drafts, spam, and transients
-* **Unused Assets** - Find and delete inactive plugins and themes
-* **Email Reports** - Configurable daily, weekly, or monthly reports
-* **Toolbar Widget** - Real-time memory and query stats (admin only)
+📊 **Dashboard & Monitoring**
+* View top 5 resource consumers at a glance
+* Real-time memory and query statistics
+* Per-request tracking and analysis
+* Historical data with configurable retention
+
+⚡ **Server Limits Display**
+* PHP memory limits (current and peak)
+* Maximum execution time settings
+* Upload file size limits
+* Post max size configurations
+* Complete server environment overview
+
+🧹 **Database Cleanup Tools**
+* Remove post revisions
+* Delete auto-drafts and trashed posts
+* Clear spam and trashed comments
+* Purge expired transients
+* Clean orphaned postmeta entries
+
+🔍 **Unused Asset Detection**
+* Find and delete inactive plugins
+* Identify unused themes consuming space
+* Safe deletion with confirmation dialogs
+
+📧 **Email Reports**
+* Configurable daily, weekly, or monthly reports
+* Performance summaries delivered to your inbox
+* Resource usage trends and recommendations
+* Optimization tips based on your site's data
+
+🛠️ **Admin Toolbar Widget**
+* Real-time memory and query stats
+* Quick access to monitoring dashboard
+* Visible only to administrators
+
+= How It Works =
+
+1. **Activation**: Plugin starts tracking resource usage immediately after activation
+2. **Monitoring**: Each page load is analyzed for memory, queries, and execution time
+3. **Analysis**: Data is aggregated to identify top resource consumers
+4. **Reporting**: Regular reports notify you of performance issues
+5. **Optimization**: Use cleanup tools to reduce bloat and improve performance
+6. **Maintenance**: Configure retention periods to manage stored data
+
+= Use Cases =
+
+* **Performance Debugging**: Identify which plugins or themes are consuming the most resources
+* **Database Optimization**: Clean up bloat from revisions, drafts, spam, and orphaned data
+* **Server Monitoring**: Keep track of server limits and resource availability
+* **Proactive Maintenance**: Receive regular reports before performance issues become critical
+* **Site Auditing**: Evaluate resource usage before and after installing new plugins
+* **Hosting Optimization**: Make informed decisions about hosting resources based on actual usage
 
 = What Gets Monitored =
 
 * Memory usage (current and peak)
-* Database query count and time
+* Database query count and execution time
 * Page load execution time
-* Per-request statistics
+* Per-request statistics and trends
+* Plugin and theme resource consumption
 
 = Cleanup Options =
 
-* Post revisions
+* Post revisions (all or keep a specific number)
 * Auto-drafts
 * Trashed posts and comments
 * Spam comments
 * Expired transients
-* Orphaned postmeta
+* Orphaned postmeta entries
 
 == Installation ==
 
 1. Upload the `hungry-resource-monitor` folder to `/wp-content/plugins/`
-2. Activate the plugin through the 'Plugins' menu
+2. Activate the plugin through the 'Plugins' menu in WordPress
 3. Navigate to 'Resource Monitor' in your admin menu
 4. Configure settings as needed
+5. Start monitoring your site's performance!
 
 == Frequently Asked Questions ==
@@ -53 +103 @@
 = Does this plugin slow down my site? =
 
-No. The plugin uses minimal resources and only tracks data on page load. Tracking can be disabled in settings.
+No. The plugin uses minimal resources and only tracks data on page load. The tracking overhead is negligible and designed to have virtually no impact on your site's performance. Tracking can be completely disabled in settings if needed.
 
 = How long is data stored? =
 
-By default, 30 days. This is configurable in Settings.
+By default, 30 days. This is configurable in Settings. You can increase or decrease the retention period based on your needs and database size considerations.
 
 = Is this compatible with caching plugins? =
 
-Yes. Resource tracking happens before output caching.
+Yes. Resource tracking happens at the PHP level before output caching, so it works seamlessly with all major caching plugins including WP Super Cache, W3 Total Cache, LiteSpeed Cache, and others.
+
+= Will the cleanup tools break my site? =
+
+No. The cleanup tools only remove data that is safe to delete (revisions, drafts, spam, trash, expired transients, orphaned metadata). However, as with any database operation, we recommend backing up your site before performing cleanup operations.
+
+= Can I exclude certain data from cleanup? =
+
+The plugin follows WordPress best practices for cleanup operations. Post revisions are removed entirely, but your published content is never touched. Only safe-to-delete data is included in cleanup operations.
+
+= How accurate is the resource monitoring? =
+
+The plugin tracks actual memory usage and query counts reported by PHP and WordPress. The data reflects real resource consumption on your server during each page load.
+
+= Does this work on multisite installations? =
+
+Yes, the plugin works on both single-site and multisite WordPress installations. On multisite, monitoring is performed per-site.
+
+= Can I customize the email report schedule? =
+
+Yes! You can configure reports to be sent daily, weekly, or monthly. Simply adjust the settings in the plugin's Settings tab.
+
+= What permissions are required? =
+
+The plugin requires administrator privileges to access the monitoring dashboard and cleanup tools. The admin toolbar widget is only visible to administrators.
+
+= Does this plugin collect any data externally? =
+
+No. All data is stored locally in your WordPress database. No data is sent to external servers or third-party services.
+
+== Screenshots ==
+
+1. Dashboard showing top resource consumers and real-time statistics
+2. Server Limits tab displaying PHP configuration and environment details
+3. Database Cleanup interface with selectable cleanup options
+4. Unused Assets tab showing inactive plugins and themes
+5. Settings page with email report configuration and data retention options
 
 == Changelog ==
+
+= 1.0.1 =
+* Security: Upgraded Chart.js to v4.5.1
+* Fixed: Replaced inline JavaScript and CSS with proper wp_enqueue_script() and wp_enqueue_style()
+* Fixed: Removed unauthorized function calls
+* Improved: WordPress.org compliance updates
 
 = 1.0.0 =
@@ -76 +168 @@
 == Upgrade Notice ==
 
+= 1.0.1 =
+Security update: Upgraded Chart.js, improved code quality, and WordPress.org compliance. Recommended for all users.
+
 = 1.0.0 =
-Initial release.
+Initial release of Hungry Resource Monitor. Install now to start monitoring your WordPress site's resource usage!
+
+== Support ==
+
+For support, feature requests, or bug reports:
+* Website: https://nandann.com
+* Subject: WordPress Development Help Request
+
+Professional WordPress development and troubleshooting services available. Expert solutions for complex WordPress challenges including custom development, site migrations, security audits, and performance optimization.
+
+== Privacy ==
+
+This plugin does not collect, store, or transmit any personal data to external services. All monitoring data is stored locally in your WordPress database.
+
+The plugin stores the following information in your WordPress database:
+* Resource usage statistics (memory, queries, execution time)
+* Page load timestamps
+* Plugin settings and configurations
+
+This data is used solely for monitoring and plugin functionality.
+
+The plugin does not:
+* Send data to external servers
+* Use third-party APIs for tracking or analytics
+* Track users across sites
+* Share data with third parties
+* Collect any personal or identifiable information
+
+All data remains on your server under your control.
+
+== About the Developer ==
+
+**Prakhar Bhatia** is a professional WordPress developer and troubleshooter with extensive experience in:
+
+* **WordPress Troubleshooting**: Expert diagnosis and resolution of complex WordPress issues, performance optimization, and security hardening
+* **Custom Development**: Bespoke WordPress plugins, themes, and custom functionality tailored to specific business needs
+* **Site Migration & Hosting**: Seamless website migrations, hosting optimization, and server configuration for peak performance
+* **Security & Maintenance**: Comprehensive security audits, malware removal, and ongoing maintenance to keep sites secure
+
+**Nandann Creative Agency** specializes in WordPress development solutions for businesses of all sizes.
+
+Website: https://nandann.com
+
+== Credits ==
+
+Built with performance and reliability in mind. Developed by Prakhar Bhatia at Nandann Creative Agency.