docs: refresh README for v1.0.12 + WordPress.org launch#30
Merged
Conversation
Brings the GitHub-facing README in sync with what actually shipped. The previous version was stuck at Version: 1.0.3 and missed nine releases of changes. Accuracy fixes - LCP/FCP numbers (1.8s/0.8s -> 1.4s/1.0s) now match readme.txt and the Performance Impact table. The two docs no longer contradict. - Admin menu location: 'Settings > Image Optimizer' -> top-level 'ODR Image Optimizer' entry with a Settings submenu (the menu has been top-level since 1.0.4; the README never caught up). - Setting name: 'Remove Bloat Scripts' renamed to 'Kill Bloat' to match the toggle label users actually see + the code's kill_bloat setting key. - Version footer bumped to 1.0.12. - Removed personal email from the footer (same scraping concern that drove removing it from readme.txt in 1.0.10). Stale 'in progress' notes cleaned - LSP section: 'Status: ~95% Implemented' + 'What's Being Improved' -> 'Fully Implemented' with the work folded into the prose. The improvements landed releases ago. - DIP section: same treatment. 'Status: ~85% Implemented, Improving' -> 'Fully Implemented'. New beats added - WP.org badge + 'Available on the WordPress.org Plugin Directory' callout at the top. - 'Release Flow' section documenting the GitHub -> SVN auto-deploy via 10up/action-wordpress-plugin-deploy, including required repo secrets and the one-line tag-push release ritual. - Security & Compliance: added the backup-storage compliance rule (under wp_upload_dir(), never in the plugin folder — the 1.0.8 fix) and the uninstall.php cleanup. - CLAUDE.md added to the Architecture Documentation list. Also added .private/ to .gitignore from earlier in the session (the folder holds local drafts like the LinkedIn launch post and shouldn't be committed or shipped).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the GitHub-facing README in sync with what actually shipped. The previous version was stuck at `Version: 1.0.3` and had missed nine releases of changes; with the WP.org listing now live, anyone landing on the repo for the first time should see an accurate picture.
What changed
Accuracy fixes
Stale 'in progress' notes cleaned
Both the LSP and DIP sections had `Status: ~95% Implemented` / `Status: ~85% Implemented, Improving` headers with `What's Being Improved` lists. The work in those lists landed releases ago. Both sections now read as `Fully Implemented` with the improvements folded into the prose.
New beats
Also
Test plan