Skip to content

Upgrade readme#835

Merged
masteradhoc merged 1 commit into
WordPress:masterfrom
masteradhoc:readme-update
Mar 15, 2026
Merged

Upgrade readme#835
masteradhoc merged 1 commit into
WordPress:masterfrom
masteradhoc:readme-update

Conversation

@masteradhoc
Copy link
Copy Markdown
Collaborator

What?

Updates readme.md to improve the structure and content of the plugin's documentation header.

Why?

The previous readme lacked a banner image, proper badge organization, and a ## Description section. This improves the first-impression presentation of the plugin.

How?

  • Adds a WordPress.org banner image at the top of the readme
  • Reorganizes badge links (Test, Deploy, WordPress Playground Demo) into a cleaner layout
  • Adds PHP version, WordPress version, tested-up-to, and license badge shields
  • Adds WP.org Rating, Downloads, and Active Installs badge shields
  • Adds a ## Description section explaining that the plugin adds a second form of authentication to protect against unauthorized access even if passwords are compromised

Testing Instructions

  1. View readme.md on GitHub or in a Markdown previewer
  2. Verify the changes

Screenshots or screencast

Old Header:
image

New Header:
image

Changelog Entry

Changed - Improved readme.md structure with banner image, reorganized badges, and a dedicated Description section.

@masteradhoc masteradhoc marked this pull request as ready for review March 13, 2026 23:01
@github-actions
Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: masteradhoc <masteradhoc@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@masteradhoc masteradhoc requested a review from jeffpaul March 13, 2026 23:01
@masteradhoc masteradhoc self-assigned this Mar 13, 2026
@masteradhoc masteradhoc added this to the 0.16.0 milestone Mar 13, 2026
@masteradhoc masteradhoc merged commit acb26c0 into WordPress:master Mar 15, 2026
30 checks passed
@masteradhoc masteradhoc deleted the readme-update branch March 15, 2026 21:32
masteradhoc added a commit that referenced this pull request Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants